QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
#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... | |
QMap< QString, QgsProperty > | parameters () const |
Returns the dynamic SVG parameters. More... | |
QString | path () const |
Returns the marker SVG path. More... | |
void | prepareExpressions (const QgsSymbolRenderContext &context) override |
Prepares all data defined property expressions for evaluation. More... | |
bool | preservedAspectRatio () const |
Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0. More... | |
QVariantMap | 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 | setParameters (const QMap< QString, QgsProperty > ¶meters) |
Sets the dynamic SVG parameters. 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 |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. More... | |
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... | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. More... | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. 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 QVariantMap &props) const override |
Writes the symbol layer definition as a SLD XML element. More... | |
![]() | |
QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)=delete | |
QgsMarkerSymbolLayer cannot be copied. More... | |
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... | |
QgsMarkerSymbolLayer & | operator= (const QgsMarkerSymbolLayer &other)=delete |
QgsMarkerSymbolLayer cannot be copied. 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 |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. More... | |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. More... | |
![]() | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
virtual | ~QgsSymbolLayer () |
virtual bool | canCauseArtifactsBetweenAdjacentTiles () const |
Returns true if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry. More... | |
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 QgsSymbolLayerReferenceList | masks () const |
Returns masks defined by this symbol layer. More... | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsSymbolLayer cannot be copied. More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. 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 void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called before the layer will be rendered for a particular feature. More... | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. More... | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. More... | |
QgsSymbol::SymbolType | type () const |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates the symbol. More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
static void | resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) |
Turns relative paths in properties map to absolute when reading and vice versa when writing. More... | |
![]() | |
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... | |
![]() | |
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 |
![]() | |
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 QVariantMap &stringMap) |
Restores older data defined properties from string map. More... | |
Definition at line 493 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 1869 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 2633 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 2266 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2383 of file qgsmarkersymbollayer.cpp.
|
static |
Creates the symbol.
Definition at line 1883 of file qgsmarkersymbollayer.cpp.
|
static |
Definition at line 2468 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the default marker aspect ratio between width and height, 0 if not yet calculated.
Definition at line 549 of file qgsmarkersymbollayer.h.
|
inlineoverridevirtual |
Gets fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 587 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 577 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 2091 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2428 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 2412 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the dynamic SVG parameters.
Definition at line 600 of file qgsmarkersymbollayer.h.
|
inline |
Returns the marker SVG path.
Definition at line 536 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Prepares all data defined property expressions for evaluation.
This should be called prior to evaluating data defined properties.
context | symbol render context |
Reimplemented from QgsSymbolLayer.
Definition at line 3625 of file qgsmarkersymbollayer.cpp.
|
inline |
Returns the preserved aspect ratio value, true
if fixed aspect ratio has been lower or equal to 0.
Definition at line 562 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 2346 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 2107 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 1992 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Set fill color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 588 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 585 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2422 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 2406 of file qgsmarkersymbollayer.cpp.
void QgsSvgMarkerSymbolLayer::setParameters | ( | const QMap< QString, QgsProperty > & | parameters | ) |
Sets the dynamic SVG parameters.
Definition at line 2085 of file qgsmarkersymbollayer.cpp.
void QgsSvgMarkerSymbolLayer::setPath | ( | const QString & | path | ) |
Set the marker SVG path.
path | SVG path |
Definition at line 2008 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 2071 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Set stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 591 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 594 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 621 of file qgsmarkersymbollayer.h.
|
inline |
Sets the units for the stroke width.
unit | width units |
Definition at line 613 of file qgsmarkersymbollayer.h.
|
overridevirtual |
Called before a set of rendering operations commences on the supplied render context.
This is always followed by a call to stopRender() after all rendering operations have been completed.
Subclasses can use this method to prepare for a set of rendering operations, e.g. by pre-evaluating paths or images to render, and performing other one-time optimisations.
Implements QgsSymbolLayer.
Definition at line 2096 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Called after a set of rendering operations has finished on the supplied render context.
This is always preceded by a call to startRender() before all rendering operations are commenced.
Subclasses can use this method to cleanup after a set of rendering operations.
Implements QgsSymbolLayer.
Definition at line 2102 of file qgsmarkersymbollayer.cpp.
|
inlineoverridevirtual |
Gets stroke color.
Supported by marker and fill layers.
Reimplemented from QgsSymbolLayer.
Definition at line 590 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 593 of file qgsmarkersymbollayer.h.
|
inline |
Definition at line 622 of file qgsmarkersymbollayer.h.
|
inline |
Returns the units for the stroke width.
Definition at line 619 of file qgsmarkersymbollayer.h.
double QgsSvgMarkerSymbolLayer::updateDefaultAspectRatio | ( | ) |
Calculates the default marker aspect ratio between width and height.
Definition at line 2056 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Returns the set of attributes referenced by the layer.
This includes attributes required by any data defined properties associated with the layer.
Reimplemented from QgsSymbolLayer.
Definition at line 3635 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 2376 of file qgsmarkersymbollayer.cpp.
|
overridevirtual |
write as DXF
Reimplemented from QgsSymbolLayer.
Definition at line 2512 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 2437 of file qgsmarkersymbollayer.cpp.
|
protected |
The marker default aspect ratio.
Definition at line 651 of file qgsmarkersymbollayer.h.
|
protected |
The marker fixed aspect ratio.
Definition at line 653 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 656 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 659 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 648 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 657 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 658 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 662 of file qgsmarkersymbollayer.h.
|
protected |
Definition at line 661 of file qgsmarkersymbollayer.h.