QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
Abstract base class for simple marker symbol layers. More...
#include <qgsmarkersymbollayer.h>
Public Member Functions | |
QgsSimpleMarkerSymbolLayerBase (Qgis::MarkerShape shape=Qgis::MarkerShape::Circle, double size=DEFAULT_SIMPLEMARKER_SIZE, double angle=DEFAULT_SIMPLEMARKER_ANGLE, Qgis::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD) | |
Constructor for QgsSimpleMarkerSymbolLayerBase. More... | |
~QgsSimpleMarkerSymbolLayerBase () override | |
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... | |
void | renderPoint (QPointF point, QgsSymbolRenderContext &context) override |
Renders a marker at the specified point. More... | |
void | setShape (Qgis::MarkerShape shape) |
Sets the rendered marker shape. More... | |
Qgis::MarkerShape | shape () const |
Returns the shape for the rendered marker symbol. 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... | |
Public Member Functions inherited from QgsMarkerSymbolLayer | |
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... | |
Public Member Functions inherited from QgsSymbolLayer | |
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 void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0 |
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 QgsMapUnitScale | mapUnitScale () const |
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... | |
virtual QgsUnitTypes::RenderUnit | outputUnit () const |
Returns the units to use for sizes and widths within the symbol layer. 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... | |
virtual void | setMapUnitScale (const QgsMapUnitScale &scale) |
virtual void | setOutputUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units to use for sizes and widths within the symbol layer. 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 | startRender (QgsSymbolRenderContext &context)=0 |
Called before a set of rendering operations commences on the supplied render context. More... | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. More... | |
virtual void | stopRender (QgsSymbolRenderContext &context)=0 |
Called after a set of rendering operations has finished on the supplied render context. 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... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const |
Saves the symbol layer as SLD. 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... | |
Static Public Member Functions | |
static QList< Qgis::MarkerShape > | availableShapes () |
Returns a list of all available shape types. More... | |
static Qgis::MarkerShape | decodeShape (const QString &name, bool *ok=nullptr) |
Attempts to decode a string representation of a shape name to the corresponding shape. More... | |
static QString | encodeShape (Qgis::MarkerShape shape) |
Encodes a shape to its string representation. More... | |
static bool | shapeIsFilled (Qgis::MarkerShape shape) |
Returns true if a symbol shape has a fill. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
void | calculateOffsetAndRotation (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle) const |
Calculates the marker offset and rotation. More... | |
double | calculateSize (QgsSymbolRenderContext &context, bool &hasDataDefinedSize) const |
Calculates the desired size of the marker, considering data defined size overrides. More... | |
bool | prepareMarkerPath (Qgis::MarkerShape symbol) |
Prepares the layer for drawing the specified shape (QPainterPath version) More... | |
bool | prepareMarkerShape (Qgis::MarkerShape shape) |
Prepares the layer for drawing the specified shape (QPolygonF version) More... | |
bool | shapeToPolygon (Qgis::MarkerShape shape, QPolygonF &polygon) const |
Creates a polygon representing the specified shape. 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 (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... | |
Protected Attributes | |
QPainterPath | mPath |
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath. More... | |
QPolygonF | mPolygon |
Polygon of points in shape. If polygon is empty then shape is using mPath. More... | |
Qgis::MarkerShape | mShape |
Symbol shape. More... | |
Protected Attributes inherited from QgsMarkerSymbolLayer | |
double | mAngle = 0 |
Marker rotation angle, in degrees clockwise from north. More... | |
HorizontalAnchorPoint | mHorizontalAnchorPoint = HCenter |
Horizontal anchor point. More... | |
double | mLineAngle = 0 |
Line rotation angle (see setLineAngle() for details) More... | |
QPointF | mOffset |
Marker offset. More... | |
QgsMapUnitScale | mOffsetMapUnitScale |
Offset map unit scale. More... | |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
Offset units. More... | |
Qgis::ScaleMethod | mScaleMethod = Qgis::ScaleMethod::ScaleDiameter |
Marker size scaling method. More... | |
double | mSize = 2.0 |
Marker size. More... | |
QgsMapUnitScale | mSizeMapUnitScale |
Marker size map unit scale. More... | |
QgsUnitTypes::RenderUnit | mSizeUnit = QgsUnitTypes::RenderMillimeters |
Marker size unit. More... | |
VerticalAnchorPoint | mVerticalAnchorPoint = VCenter |
Vertical anchor point. More... | |
Protected Attributes inherited from QgsSymbolLayer | |
QPainterPath | mClipPath |
QColor | mColor |
QgsPropertyCollection | mDataDefinedProperties |
bool | mEnabled = true |
True if layer is enabled and should be drawn. More... | |
QgsFields | mFields |
bool | mLocked = false |
std::unique_ptr< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
Qgis::SymbolType | mType |
Abstract base class for simple marker symbol layers.
Handles creation of the symbol shapes but leaves the actual drawing of the symbols to subclasses.
Definition at line 46 of file qgsmarkersymbollayer.h.
QgsSimpleMarkerSymbolLayerBase::QgsSimpleMarkerSymbolLayerBase | ( | Qgis::MarkerShape | shape = Qgis::MarkerShape::Circle , |
double | size = DEFAULT_SIMPLEMARKER_SIZE , |
||
double | angle = DEFAULT_SIMPLEMARKER_ANGLE , |
||
Qgis::ScaleMethod | scaleMethod = DEFAULT_SCALE_METHOD |
||
) |
Constructor for QgsSimpleMarkerSymbolLayerBase.
shape | symbol shape for markers |
size | symbol size (in mm) |
angle | symbol rotation angle |
scaleMethod | scaling method for data defined scaling |
Definition at line 110 of file qgsmarkersymbollayer.cpp.
|
overridedefault |
|
static |
Returns a list of all available shape types.
Definition at line 66 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.
Reimplemented in QgsSimpleMarkerSymbolLayer.
Definition at line 305 of file qgsmarkersymbollayer.cpp.
|
protected |
Calculates the marker offset and rotation.
context | symbol render context |
scaledSize | size of symbol to render |
hasDataDefinedRotation | will be set to true if marker has data defined rotation |
offset | will be set to calculated marker offset (in painter units) |
angle | will be set to calculated marker angle |
Definition at line 923 of file qgsmarkersymbollayer.cpp.
|
protected |
Calculates the desired size of the marker, considering data defined size overrides.
context | symbol render context |
hasDataDefinedSize | will be set to true if marker uses data defined sizes |
Definition at line 895 of file qgsmarkersymbollayer.cpp.
|
static |
Attempts to decode a string representation of a shape name to the corresponding shape.
name | encoded shape name |
ok | if specified, will be set to true if shape was successfully decoded |
Definition at line 331 of file qgsmarkersymbollayer.cpp.
|
static |
Encodes a shape to its string representation.
shape | shape to encode |
Definition at line 417 of file qgsmarkersymbollayer.cpp.
|
protected |
Prepares the layer for drawing the specified shape (QPainterPath version)
Definition at line 788 of file qgsmarkersymbollayer.cpp.
|
protected |
Prepares the layer for drawing the specified shape (QPolygonF version)
Definition at line 499 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.
Reimplemented in QgsSimpleMarkerSymbolLayer.
Definition at line 219 of file qgsmarkersymbollayer.cpp.
|
inline |
Sets the rendered marker shape.
shape | new marker shape |
Definition at line 86 of file qgsmarkersymbollayer.h.
|
inline |
Returns the shape for the rendered marker symbol.
Definition at line 79 of file qgsmarkersymbollayer.h.
|
static |
Returns true
if a symbol shape has a fill.
shape | shape to test |
true
if shape uses a fill, or false
if shape uses lines only Definition at line 123 of file qgsmarkersymbollayer.cpp.
|
protected |
Creates a polygon representing the specified shape.
shape | shape to create |
polygon | destination polygon for shape |
true
if shape was successfully stored in polygon Definition at line 504 of file qgsmarkersymbollayer.cpp.
|
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 QgsSimpleMarkerSymbolLayer, and QgsFilledMarkerSymbolLayer.
Definition at line 171 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.
Reimplemented in QgsFilledMarkerSymbolLayer.
Definition at line 214 of file qgsmarkersymbollayer.cpp.
|
protected |
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath.
Definition at line 153 of file qgsmarkersymbollayer.h.
|
protected |
Polygon of points in shape. If polygon is empty then shape is using mPath.
Definition at line 150 of file qgsmarkersymbollayer.h.
|
protected |
Symbol shape.
Definition at line 156 of file qgsmarkersymbollayer.h.