QGIS API Documentation
3.8.0-Zanzibar (11aff65)
|
#include <qgsmarkersymbollayer.h>
Public Member Functions | |
QgsSvgMarkerSymbolLayer (const QString &path, double size=DEFAULT_SVGMARKER_SIZE, double angle=DEFAULT_SVGMARKER_ANGLE, QgsSymbol::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD) | |
Constructs SVG marker symbol layer with picture from given absolute path to a SVG file. More... | |
QRectF | bounds (QPointF point, QgsSymbolRenderContext &context) override |
Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. More... | |
QgsSvgMarkerSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
double | defaultAspectRatio () const |
Returns the default marker aspect ratio between width and height, 0 if not yet calculated. More... | |
QColor | fillColor () const override |
Gets fill color. More... | |
double | fixedAspectRatio () const |
Returns the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
QString | path () const |
Returns the marker SVG path. More... | |
bool | preservedAspectRatio () const |
Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0. More... | |
QgsStringMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
void | renderPoint (QPointF point, QgsSymbolRenderContext &context) override |
Renders a marker at the specified point. More... | |
void | setFillColor (const QColor &color) override |
Set fill color. More... | |
void | setFixedAspectRatio (double ratio) |
Set the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setPath (const QString &path) |
Set the marker SVG path. More... | |
bool | setPreservedAspectRatio (bool par) |
Set preserved the marker aspect ratio between width and height. More... | |
void | setStrokeColor (const QColor &c) override |
Set stroke color. More... | |
void | setStrokeWidth (double w) |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the stroke width. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
QColor | strokeColor () const override |
Gets stroke color. More... | |
double | strokeWidth () const |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the units for the stroke width. More... | |
double | updateDefaultAspectRatio () |
Calculates the default marker aspect ratio between width and height. More... | |
bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override |
write as DXF More... | |
void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
Writes the symbol layer definition as a SLD XML element. More... | |
Public Member Functions inherited from QgsMarkerSymbolLayer | |
double | angle () const |
Returns the rotation angle for the marker, in degrees clockwise from north. More... | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
HorizontalAnchorPoint | horizontalAnchorPoint () const |
Returns the horizontal anchor point for positioning the symbol. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QPointF | offset () const |
Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the symbol's offset. More... | |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units for the symbol's offset. More... | |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
QgsSymbol::ScaleMethod | scaleMethod () const |
Returns the method to use for scaling the marker's size. More... | |
void | setAngle (double angle) |
Sets the rotation angle for the marker. More... | |
void | setHorizontalAnchorPoint (HorizontalAnchorPoint h) |
Sets the horizontal anchor point for positioning the symbol. More... | |
void | setLineAngle (double lineAngle) |
Sets the line angle modification for the symbol's angle. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (QPointF offset) |
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's offset. More... | |
void | setOffsetUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's offset. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setScaleMethod (QgsSymbol::ScaleMethod scaleMethod) |
Sets the method to use for scaling the marker's size. More... | |
virtual void | setSize (double size) |
Sets the symbol size. More... | |
void | setSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's size. More... | |
void | setSizeUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's size. More... | |
void | setVerticalAnchorPoint (VerticalAnchorPoint v) |
Sets the vertical anchor point for positioning the symbol. More... | |
double | size () const |
Returns the symbol size. More... | |
const QgsMapUnitScale & | sizeMapUnitScale () const |
Returns the map unit scale for the symbol's size. More... | |
QgsUnitTypes::RenderUnit | sizeUnit () const |
Returns the units for the symbol's size. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. More... | |
Public Member Functions inherited from QgsSymbolLayer | |
virtual | ~QgsSymbolLayer () |
virtual QColor | color () const |
The fill color. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const |
Gets angle. More... | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
Gets brush/fill color. More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
Gets brush/fill style. More... | |
virtual QColor | dxfColor (QgsSymbolRenderContext &context) const |
Gets color. More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
Gets dash pattern. More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
Gets pen style. More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets line width. More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. More... | |
virtual double | estimateMaxBleed (const QgsRenderContext &context) const |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More... | |
virtual bool | hasDataDefinedProperties () const |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. More... | |
bool | isLocked () const |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. More... | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual void | setColor (const QColor &color) |
The fill color. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. More... | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. More... | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. More... | |
void | setLocked (bool locked) |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual bool | setSubSymbol (QgsSymbol *symbol) |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. More... | |
QgsSymbol::SymbolType | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const |
Returns the set of attributes referenced by the layer. More... | |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QgsStringMap &properties=QgsStringMap()) |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
static void | resolvePaths (QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving) |
Turns relative paths in properties map to absolute when reading and vice versa when writing. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
double | calculateAspectRatio (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio) const |
Calculates the marker aspect ratio between width and height. More... | |
Protected Member Functions inherited from QgsMarkerSymbolLayer | |
QgsMarkerSymbolLayer (bool locked=false) | |
Constructor for QgsMarkerSymbolLayer. More... | |
void | markerOffset (QgsSymbolRenderContext &context, double &offsetX, double &offsetY) const |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More... | |
void | markerOffset (QgsSymbolRenderContext &context, double width, double height, double &offsetX, double &offsetY) const |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More... | |
void | markerOffset (QgsSymbolRenderContext &context, double width, double height, QgsUnitTypes::RenderUnit widthUnit, QgsUnitTypes::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false) | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
void | restoreOldDataDefinedProperties (const QgsStringMap &stringMap) |
Restores older data defined properties from string map. More... | |
Definition at line 482 of file qgsmarkersymbollayer.h.
QgsSvgMarkerSymbolLayer::QgsSvgMarkerSymbolLayer | ( | const QString & | path, |
double | size = DEFAULT_SVGMARKER_SIZE , |
||
double | angle = DEFAULT_SVGMARKER_ANGLE , |
||
QgsSymbol::ScaleMethod | scaleMethod = DEFAULT_SCALE_METHOD |
||
) |
Constructs SVG marker symbol layer with picture from given absolute path to a SVG file.
Definition at line 1707 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.
Implements QgsMarkerSymbolLayer.
Definition at line 2474 of file qgsmarkersymbollayer.cpp.
|
protected |
Calculates the marker aspect ratio between width and height.
context | symbol render context |
scaledSize | size of symbol to render |
hasDataDefinedAspectRatio | will be set to true if marker has data defined aspectRatio |
Definition at line 2127 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2230 of file qgsmarkersymbollayer.cpp.
|
static |
Definition at line 1722 of file qgsmarkersymbollayer.cpp.
|
static |
Definition at line 2313 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
Definition at line 536 of file qgsmarkersymbollayer.h.
|
inlineoverridevirtual |
Gets fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 574 of file qgsmarkersymbollayer.h.
|
inline |
Returns the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering.
Definition at line 564 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Returns a string that represents this layer type.
Used for serialization. Should match with the string used to register this symbol layer in the registry.
Implements QgsSymbolLayer.
Definition at line 1945 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2273 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Returns the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
Reimplemented from QgsSymbolLayer.
Definition at line 2257 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the marker SVG path.
Definition at line 523 of file qgsmarkersymbollayer.h.
|
inline |
Returns the preserved aspect ratio value, true
if fixed aspect ratio has been lower or equal to 0.
Definition at line 549 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.
This is used to serialize a symbol layer perstistently.
Implements QgsSymbolLayer.
Definition at line 2207 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Renders a marker at the specified point.
Derived classes must implement this to handle drawing the point.
point | position at which to render point, in painter units |
context | symbol render context |
Implements QgsMarkerSymbolLayer.
Definition at line 1961 of file qgsmarkersymbollayer.cpp.
|
static |
Turns relative paths in properties map to absolute when reading and vice versa when writing.
Used internally when reading/writing symbols.
Definition at line 1857 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Set fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 575 of file qgsmarkersymbollayer.h.
|
inline |
Set the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering.
ratio | Fixed Aspect Ratio |
Definition at line 572 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2267 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Sets the units to use for sizes and widths within the symbol layer.
Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.
unit | output units |
Reimplemented from QgsSymbolLayer.
Definition at line 2251 of file qgsmarkersymbollayer.cpp.
void QgsSvgMarkerSymbolLayer::setPath | ( | const QString & | path | ) |
Set the marker SVG path.
path | SVG path |
Definition at line 1869 of file qgsmarkersymbollayer.cpp.
bool QgsSvgMarkerSymbolLayer::setPreservedAspectRatio | ( | bool | par | ) |
Set preserved the marker aspect ratio between width and height.
par | Preserved Aspect Ratio |
true
if fixed aspect ratio has been lower or equal to 0 Definition at line 1930 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Set stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 578 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 581 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 596 of file qgsmarkersymbollayer.h.
|
inline |
Sets the units for the stroke width.
unit | width units |
Definition at line 588 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 1950 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 1956 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Gets stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 577 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 580 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 597 of file qgsmarkersymbollayer.h.
|
inline |
Returns the units for the stroke width.
Definition at line 594 of file qgsmarkersymbollayer.h.
double QgsSvgMarkerSymbolLayer::updateDefaultAspectRatio | ( | ) |
Calculates the default marker aspect ratio between width and height.
Definition at line 1915 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
write as DXF
Reimplemented from QgsSymbolLayer.
Definition at line 2357 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Writes the symbol layer definition as a SLD XML element.
doc | XML document |
element | parent XML element |
props | symbol layer definition (see properties()) |
Reimplemented from QgsMarkerSymbolLayer.
Definition at line 2282 of file qgsmarkersymbollayer.cpp.
|
protected |
The marker default aspect ratio.
Definition at line 622 of file qgsmarkersymbollayer.h.
|
protected |
The marker fixed aspect ratio.
Definition at line 624 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 619 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 627 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 628 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 630 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 629 of file qgsmarkersymbollayer.h.