QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
Abstract base class for marker symbol layers. More...
#include <qgssymbollayer.h>
Public Member Functions | |
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... | |
virtual QRectF | bounds (QPointF point, QgsSymbolRenderContext &context)=0 |
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... | |
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... | |
virtual void | renderPoint (QPointF point, QgsSymbolRenderContext &context)=0 |
Renders a marker at the specified point. More... | |
Qgis::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 (Qgis::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... | |
virtual void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const |
Writes the symbol layer definition as a SLD XML element. 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 QgsSymbolLayer * | clone () const =0 |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
virtual QColor | color () const |
Returns the "representative" color of the symbol layer. 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 QColor | fillColor () const |
Returns the fill color for the symbol layer. More... | |
virtual Qgis::SymbolLayerFlags | flags () const |
Returns flags which control the symbol layer's behavior. 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 |
Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More... | |
virtual QString | layerType () const =0 |
Returns a string that represents this layer type. More... | |
virtual QList< QgsSymbolLayerReference > | 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... | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
virtual void | prepareMasks (const QgsSymbolRenderContext &context) |
Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method. More... | |
virtual QVariantMap | properties () const =0 |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual void | setColor (const QColor &color) |
Sets the "representative" color for the symbol layer. 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... | |
virtual void | setFillColor (const QColor &color) |
Sets the fill color for the symbol layer. More... | |
void | setLocked (bool locked) |
Sets whether the layer's colors are locked. More... | |
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 void | setStrokeColor (const QColor &color) |
Sets the stroke color for the symbol layer. 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 QColor | strokeColor () const |
Returns the stroke color for the symbol layer. More... | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. More... | |
Qgis::SymbolType | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const |
Returns the set of attributes referenced by the layer. More... | |
virtual bool | usesMapUnits () const |
Returns true if the symbol layer has any components which use map unit based sizes. More... | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
Protected Member Functions | |
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 (Qgis::SymbolType type, bool locked=false) | |
Constructor for QgsSymbolLayer. More... | |
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... | |
Static Protected Member Functions | |
static QPointF | _rotatedOffset (QPointF offset, double angle) |
Adjusts a marker offset to account for rotation. More... | |
Additional Inherited Members | |
![]() | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
![]() | |
static const bool | SELECT_FILL_BORDER = false |
Whether fill styles for selected features also highlight symbol stroke. More... | |
static const bool | SELECT_FILL_STYLE = false |
Whether fill styles for selected features uses symbol layer style. More... | |
static const bool | SELECTION_IS_OPAQUE = true |
Whether styles for selected features ignore symbol alpha. More... | |
Abstract base class for marker symbol layers.
Definition at line 705 of file qgssymbollayer.h.
Symbol horizontal anchor points.
Enumerator | |
---|---|
Left | Align to left side of symbol. |
HCenter | Align to horizontal center of symbol. |
Right | Align to right side of symbol. |
Definition at line 710 of file qgssymbollayer.h.
Symbol vertical anchor points.
Enumerator | |
---|---|
Top | Align to top of symbol. |
VCenter | Align to vertical center of symbol. |
Bottom | Align to bottom of symbol. |
Definition at line 718 of file qgssymbollayer.h.
|
delete |
QgsMarkerSymbolLayer cannot be copied.
|
protected |
Constructor for QgsMarkerSymbolLayer.
locked | set to true to lock symbol color |
Definition at line 502 of file qgssymbollayer.cpp.
|
staticprotected |
Adjusts a marker offset to account for rotation.
offset | offset prior to rotation |
angle | rotation angle in degrees clockwise from north |
Definition at line 652 of file qgssymbollayer.cpp.
|
inline |
Returns the rotation angle for the marker, in degrees clockwise from north.
Definition at line 757 of file qgssymbollayer.h.
|
pure virtual |
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.
Implemented in QgsVectorFieldSymbolLayer, QgsFontMarkerSymbolLayer, QgsRasterMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsEllipseSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSimpleMarkerSymbolLayerBase, and QgsMaskMarkerSymbolLayer.
|
overridevirtual |
Implements QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 538 of file qgssymbollayer.cpp.
|
inline |
Returns the horizontal anchor point for positioning the symbol.
The symbol will be drawn so that the horizontal anchor point is aligned with the marker's desired location.
Definition at line 902 of file qgssymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 712 of file qgssymbollayer.cpp.
|
protected |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.
context | symbol render context |
offsetX | will be set to required horizontal offset (in painter units) |
offsetY | will be set to required vertical offset (in painter units) |
Definition at line 558 of file qgssymbollayer.cpp.
|
protected |
Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point.
context | symbol render context |
width | marker width |
height | marker height |
offsetX | will be set to required horizontal offset (in painter units) |
offsetY | will be set to required vertical offset (in painter units) |
Definition at line 563 of file qgssymbollayer.cpp.
|
protected |
Definition at line 568 of file qgssymbollayer.cpp.
|
inline |
Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry.
Units are specified by offsetUnit().
Definition at line 851 of file qgssymbollayer.h.
|
inline |
Returns the map unit scale for the symbol's offset.
Definition at line 885 of file qgssymbollayer.h.
|
inline |
Returns the units for the symbol's offset.
Definition at line 868 of file qgssymbollayer.h.
|
delete |
QgsMarkerSymbolLayer cannot be copied.
|
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.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 697 of file qgssymbollayer.cpp.
|
pure virtual |
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 |
Implemented in QgsFontMarkerSymbolLayer, QgsRasterMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSimpleMarkerSymbolLayerBase, QgsVectorFieldSymbolLayer, QgsEllipseSymbolLayer, and QgsMaskMarkerSymbolLayer.
|
inline |
Returns the method to use for scaling the marker's size.
Definition at line 832 of file qgssymbollayer.h.
|
inline |
Sets the rotation angle for the marker.
angle | angle in degrees clockwise from north. |
Definition at line 751 of file qgssymbollayer.h.
|
inline |
Sets the horizontal anchor point for positioning the symbol.
h | anchor point. Symbol will be drawn so that the horizontal anchor point is aligned with the marker's desired location. |
Definition at line 894 of file qgssymbollayer.h.
|
inline |
Sets the line angle modification for the symbol's angle.
This angle is added to the marker's rotation and data defined rotation before rendering the symbol, and is usually used for orienting symbols to match a line's angle.
lineAngle | Angle in degrees clockwise from north, valid values are between 0 and 360 |
Definition at line 768 of file qgssymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 706 of file qgssymbollayer.cpp.
|
inline |
Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry.
offset | marker offset. Units are specified by offsetUnit() |
Definition at line 842 of file qgssymbollayer.h.
|
inline |
Sets the map unit scale for the symbol's offset.
scale | offset map unit scale |
Definition at line 877 of file qgssymbollayer.h.
|
inline |
Sets the units for the symbol's offset.
unit | offset units |
Definition at line 860 of file qgssymbollayer.h.
|
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.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 691 of file qgssymbollayer.cpp.
|
inline |
Sets the method to use for scaling the marker's size.
scaleMethod | scale method |
Definition at line 826 of file qgssymbollayer.h.
|
inlinevirtual |
Sets the symbol size.
size | symbol size. Units are specified by sizeUnit(). |
Reimplemented in QgsEllipseSymbolLayer.
Definition at line 777 of file qgssymbollayer.h.
|
inline |
Sets the map unit scale for the symbol's size.
scale | size map unit scale |
Definition at line 811 of file qgssymbollayer.h.
|
inline |
Sets the units for the symbol's size.
unit | size units |
Definition at line 794 of file qgssymbollayer.h.
|
inline |
Sets the vertical anchor point for positioning the symbol.
v | anchor point. Symbol will be drawn so that the vertical anchor point is aligned with the marker's desired location. |
Definition at line 911 of file qgssymbollayer.h.
|
inline |
Returns the symbol size.
Units are specified by sizeUnit().
Definition at line 785 of file qgssymbollayer.h.
|
inline |
Returns the map unit scale for the symbol's size.
Definition at line 819 of file qgssymbollayer.h.
|
inline |
Returns the units for the symbol's size.
Definition at line 802 of file qgssymbollayer.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.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 528 of file qgssymbollayer.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.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 533 of file qgssymbollayer.cpp.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Reimplemented in QgsVectorFieldSymbolLayer.
Definition at line 892 of file qgssymbollayer.cpp.
|
inline |
Returns the vertical anchor point for positioning the symbol.
The symbol will be drawn so that the vertical anchor point is aligned with the marker's desired location.
Definition at line 919 of file qgssymbollayer.h.
|
inlinevirtual |
Writes the symbol layer definition as a SLD XML element.
doc | XML document |
element | parent XML element |
props | symbol layer definition (see properties()) |
Reimplemented in QgsFontMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsEllipseSymbolLayer.
Definition at line 929 of file qgssymbollayer.h.
|
protected |
Marker rotation angle, in degrees clockwise from north.
Definition at line 989 of file qgssymbollayer.h.
|
protected |
Horizontal anchor point.
Definition at line 1007 of file qgssymbollayer.h.
|
protected |
Line rotation angle (see setLineAngle() for details)
Definition at line 991 of file qgssymbollayer.h.
|
protected |
Marker offset.
Definition at line 999 of file qgssymbollayer.h.
|
protected |
Offset map unit scale.
Definition at line 1003 of file qgssymbollayer.h.
|
protected |
Offset units.
Definition at line 1001 of file qgssymbollayer.h.
|
protected |
Marker size scaling method.
Definition at line 1005 of file qgssymbollayer.h.
|
protected |
Marker size.
Definition at line 993 of file qgssymbollayer.h.
|
protected |
Marker size map unit scale.
Definition at line 997 of file qgssymbollayer.h.
|
protected |
Marker size unit.
Definition at line 995 of file qgssymbollayer.h.
|
protected |
Vertical anchor point.
Definition at line 1009 of file qgssymbollayer.h.