QGIS API Documentation 3.41.0-Master (3440c17df1d)
|
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. | |
~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. | |
void | renderPoint (QPointF point, QgsSymbolRenderContext &context) override |
Renders a marker at the specified point. | |
void | setShape (Qgis::MarkerShape shape) |
Sets the rendered marker shape. | |
Qgis::MarkerShape | shape () const |
Returns the shape for the rendered marker symbol. | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. | |
Public Member Functions inherited from QgsMarkerSymbolLayer | |
double | angle () const |
Returns the rotation angle for the marker, in degrees clockwise from north. | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const override |
Gets angle. | |
virtual double | dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets marker size. | |
HorizontalAnchorPoint | horizontalAnchorPoint () const |
Returns the horizontal anchor point for positioning the symbol. | |
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. | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the symbol's offset. | |
Qgis::RenderUnit | offsetUnit () const |
Returns the units for the symbol's offset. | |
QgsMarkerSymbolLayer & | operator= (const QgsMarkerSymbolLayer &other)=delete |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. | |
Qgis::ScaleMethod | scaleMethod () const |
Returns the method to use for scaling the marker's size. | |
void | setAngle (double angle) |
Sets the rotation angle for the marker. | |
void | setHorizontalAnchorPoint (HorizontalAnchorPoint h) |
Sets the horizontal anchor point for positioning the symbol. | |
void | setLineAngle (double lineAngle) |
Sets the line angle modification for the symbol's angle. | |
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. | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's offset. | |
void | setOffsetUnit (Qgis::RenderUnit unit) |
Sets the units for the symbol's offset. | |
void | setOutputUnit (Qgis::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. | |
void | setScaleMethod (Qgis::ScaleMethod scaleMethod) |
Sets the method to use for scaling the marker's size. | |
virtual void | setSize (double size) |
Sets the symbol size. | |
void | setSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the symbol's size. | |
void | setSizeUnit (Qgis::RenderUnit unit) |
Sets the units for the symbol's size. | |
void | setVerticalAnchorPoint (VerticalAnchorPoint v) |
Sets the vertical anchor point for positioning the symbol. | |
double | size () const |
Returns the symbol size. | |
const QgsMapUnitScale & | sizeMapUnitScale () const |
Returns the map unit scale for the symbol's size. | |
Qgis::RenderUnit | sizeUnit () const |
Returns the units for the symbol's size. | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. | |
VerticalAnchorPoint | verticalAnchorPoint () const |
Returns the vertical anchor point for positioning the symbol. | |
virtual void | writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const |
Writes the symbol layer definition as a SLD XML element. | |
Public Member Functions inherited from QgsSymbolLayer | |
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. | |
virtual QgsSymbolLayer * | clone () const =0 |
Shall be reimplemented by subclasses to create a deep copy of the instance. | |
virtual QColor | color () const |
Returns the "representative" color of the symbol layer. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
Gets brush/fill color. | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
Gets brush/fill style. | |
virtual QColor | dxfColor (QgsSymbolRenderContext &context) const |
Gets color. | |
virtual QVector< qreal > | dxfCustomDashPattern (Qgis::RenderUnit &unit) const |
Gets dash pattern. | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. | |
virtual Qt::PenStyle | dxfPenStyle () const |
Gets pen style. | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets line width. | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. | |
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. | |
virtual QColor | fillColor () const |
Returns the fill color for the symbol layer. | |
virtual Qgis::SymbolLayerFlags | flags () const |
Returns flags which control the symbol layer's behavior. | |
virtual bool | hasDataDefinedProperties () const |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. | |
QString | id () const |
Returns symbol layer identifier This id is unique in the whole project. | |
bool | installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF()) |
When rendering, install masks on context painter. | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. | |
bool | isLocked () const |
Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. | |
virtual QString | layerType () const =0 |
Returns a string that represents this layer type. | |
virtual QList< QgsSymbolLayerReference > | masks () const |
Returns masks defined by this symbol layer. | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. | |
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. | |
virtual QVariantMap | properties () const =0 |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. | |
virtual void | setColor (const QColor &color) |
Sets the "representative" color for the symbol layer. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. | |
virtual void | setFillColor (const QColor &color) |
Sets the fill color for the symbol layer. | |
void | setId (const QString &id) |
Set symbol layer identifier This id has to be unique in the whole project. | |
void | setLocked (bool locked) |
Sets whether the layer's colors are locked. | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. | |
void | setRenderingPass (int renderingPass) |
Specifies the rendering pass in which this symbol layer should be rendered. | |
virtual void | setStrokeColor (const QColor &color) |
Sets the stroke color for the symbol layer. | |
virtual bool | setSubSymbol (QgsSymbol *symbol) |
Sets layer's subsymbol. takes ownership of the passed symbol. | |
void | setUserFlags (Qgis::SymbolLayerUserFlags flags) |
Sets user-controlled flags which control the symbol layer's behavior. | |
virtual void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called before the layer will be rendered for a particular feature. | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. | |
virtual QColor | strokeColor () const |
Returns the stroke color for the symbol layer. | |
virtual QgsSymbol * | subSymbol () |
Returns the symbol's sub symbol, if present. | |
Qgis::SymbolType | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const |
Returns the set of attributes referenced by the layer. | |
Qgis::SymbolLayerUserFlags | userFlags () const |
Returns user-controlled flags which control the symbol layer's behavior. | |
virtual bool | usesMapUnits () const |
Returns true if the symbol layer has any components which use map unit based sizes. | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF | |
Static Public Member Functions | |
static QList< Qgis::MarkerShape > | availableShapes () |
Returns a list of all available shape types. | |
static Qgis::MarkerShape | decodeShape (const QString &name, bool *ok=nullptr) |
Attempts to decode a string representation of a shape name to the corresponding shape. | |
static QString | encodeShape (Qgis::MarkerShape shape) |
Encodes a shape to its string representation. | |
static bool | shapeIsFilled (Qgis::MarkerShape shape) |
Returns true if a symbol shape has a fill. | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. | |
Protected Member Functions | |
void | calculateOffsetAndRotation (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedRotation, QPointF &offset, double &angle) const |
Calculates the marker offset and rotation. | |
double | calculateSize (QgsSymbolRenderContext &context, bool &hasDataDefinedSize) const |
Calculates the desired size of the marker, considering data defined size overrides. | |
bool | prepareMarkerPath (Qgis::MarkerShape symbol) |
Prepares the layer for drawing the specified shape (QPainterPath version) | |
bool | prepareMarkerShape (Qgis::MarkerShape shape) |
Prepares the layer for drawing the specified shape (QPolygonF version) | |
bool | shapeToPolygon (Qgis::MarkerShape shape, QPolygonF &polygon) const |
Creates a polygon representing the specified shape. | |
Protected Member Functions inherited from QgsMarkerSymbolLayer | |
QgsMarkerSymbolLayer (bool locked=false) | |
Constructor for QgsMarkerSymbolLayer. | |
QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other) | |
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. | |
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. | |
void | markerOffset (QgsSymbolRenderContext &context, double width, double height, Qgis::RenderUnit widthUnit, Qgis::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other) | |
QgsSymbolLayer (Qgis::SymbolType type, bool locked=false) | |
Constructor for QgsSymbolLayer. | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. | |
void | removeMasks (QgsRenderContext &context, bool recursive) |
When rendering, remove previously installed masks from context painter if recursive is true masks are removed recursively for all children symbol layers. | |
void | restoreOldDataDefinedProperties (const QVariantMap &stringMap) |
Restores older data defined properties from string map. | |
bool | shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const |
Returns true if the symbol layer should be rendered using the selection color from the render context. | |
Protected Attributes | |
QPainterPath | mPath |
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath. | |
QPolygonF | mPolygon |
Polygon of points in shape. If polygon is empty then shape is using mPath. | |
Qgis::MarkerShape | mShape |
Symbol shape. | |
Protected Attributes inherited from QgsMarkerSymbolLayer | |
double | mAngle = 0 |
Marker rotation angle, in degrees clockwise from north. | |
HorizontalAnchorPoint | mHorizontalAnchorPoint = HCenter |
Horizontal anchor point. | |
double | mLineAngle = 0 |
Line rotation angle (see setLineAngle() for details) | |
QPointF | mOffset |
Marker offset. | |
QgsMapUnitScale | mOffsetMapUnitScale |
Offset map unit scale. | |
Qgis::RenderUnit | mOffsetUnit = Qgis::RenderUnit::Millimeters |
Offset units. | |
Qgis::ScaleMethod | mScaleMethod = Qgis::ScaleMethod::ScaleDiameter |
Marker size scaling method. | |
double | mSize = 2.0 |
Marker size. | |
QgsMapUnitScale | mSizeMapUnitScale |
Marker size map unit scale. | |
Qgis::RenderUnit | mSizeUnit = Qgis::RenderUnit::Millimeters |
Marker size unit. | |
VerticalAnchorPoint | mVerticalAnchorPoint = VCenter |
Vertical anchor point. | |
Protected Attributes inherited from QgsSymbolLayer | |
QPainterPath | mClipPath |
QColor | mColor |
QgsPropertyCollection | mDataDefinedProperties |
bool | mEnabled = true |
True if layer is enabled and should be drawn. | |
QgsFields | mFields |
QString | mId |
bool | mLocked = false |
std::unique_ptr< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
Qgis::SymbolType | mType |
Qgis::SymbolLayerUserFlags | mUserFlags |
User controlled flags. | |
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 45 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 97 of file qgsmarkersymbollayer.cpp.
|
overridedefault |
|
static |
Returns a list of all available shape types.
Definition at line 53 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 292 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 910 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 882 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 318 of file qgsmarkersymbollayer.cpp.
|
static |
Encodes a shape to its string representation.
shape | shape to encode |
Definition at line 404 of file qgsmarkersymbollayer.cpp.
|
protected |
Prepares the layer for drawing the specified shape (QPainterPath version)
Definition at line 775 of file qgsmarkersymbollayer.cpp.
|
protected |
Prepares the layer for drawing the specified shape (QPolygonF version)
Definition at line 486 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 206 of file qgsmarkersymbollayer.cpp.
|
inline |
Sets the rendered marker shape.
shape | new marker shape |
Definition at line 85 of file qgsmarkersymbollayer.h.
|
inline |
Returns the shape for the rendered marker symbol.
Definition at line 78 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 110 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 491 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.
Reimplemented from QgsMarkerSymbolLayer.
Definition at line 158 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.
Reimplemented from QgsMarkerSymbolLayer.
Definition at line 201 of file qgsmarkersymbollayer.cpp.
|
protected |
Painter path representing shape. If mPolygon is empty then the shape is stored in mPath.
Definition at line 152 of file qgsmarkersymbollayer.h.
|
protected |
Polygon of points in shape. If polygon is empty then shape is using mPath.
Definition at line 149 of file qgsmarkersymbollayer.h.
|
protected |
Symbol shape.
Definition at line 155 of file qgsmarkersymbollayer.h.