QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
|
A fill symbol layer which places markers at random locations within polygons. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsRandomMarkerFillSymbolLayer (int pointCount=10, Qgis::PointCountMethod method=Qgis::PointCountMethod::Absolute, double densityArea=250.0, unsigned long seed=0) | |
Constructor for QgsRandomMarkerFillSymbolLayer, with the specified pointCount. More... | |
~QgsRandomMarkerFillSymbolLayer () override | |
bool | canCauseArtifactsBetweenAdjacentTiles () const override |
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... | |
bool | clipPoints () const |
Returns true if point markers should be clipped to the polygon boundary. More... | |
QgsRandomMarkerFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QColor | color () const override |
Returns the "representative" color of the symbol layer. More... | |
Qgis::PointCountMethod | countMethod () const |
Returns the count method used to randomly fill the polygon. More... | |
double | densityArea () const |
Returns the density area used to count the number of points to randomly fill the polygon. More... | |
QgsUnitTypes::RenderUnit | densityAreaUnit () const |
Returns the units for the density area. More... | |
const QgsMapUnitScale & | densityAreaUnitScale () const |
Returns the map scale for the density area. More... | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. 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... | |
int | pointCount () const |
Returns the count of random points to render in the fill. 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 | renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More... | |
unsigned long | seed () const |
Returns the random number seed to use when generating points, or 0 if a truly random sequence will be used (causing points to appear in different locations with every map refresh). More... | |
void | setClipPoints (bool clipped) |
Sets whether point markers should be clipped to the polygon boundary. More... | |
void | setColor (const QColor &color) override |
Sets the "representative" color for the symbol layer. More... | |
void | setCountMethod (Qgis::PointCountMethod method) |
Sets the count method used to randomly fill the polygon. More... | |
void | setDensityArea (double area) |
Sets the density area used to count the number of points to randomly fill the polygon. More... | |
void | setDensityAreaUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the density area. More... | |
void | setDensityAreaUnitScale (const QgsMapUnitScale &scale) |
Sets the map scale for the density area. 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 | setPointCount (int count) |
Sets the count of random points to render in the fill. More... | |
void | setSeed (unsigned long seed) |
Sets the random number seed to use when generating points, or 0 if a truly random sequence will be used on every rendering (causing points to appear in different locations with every map refresh). More... | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called before the layer will be rendered for a particular feature. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called after the layer has been rendered for a particular feature. More... | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. More... | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. 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... | |
Public Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete | |
QgsFillSymbolLayer cannot be copied. More... | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
QgsFillSymbolLayer & | operator= (const QgsFillSymbolLayer &other)=delete |
QgsFillSymbolLayer cannot be copied. More... | |
virtual void | renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)=0 |
Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. More... | |
void | setAngle (double angle) |
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 QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates a new QgsRandomMarkerFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
A fill symbol layer which places markers at random locations within polygons.
Definition at line 2239 of file qgsfillsymbollayer.h.
QgsRandomMarkerFillSymbolLayer::QgsRandomMarkerFillSymbolLayer | ( | int | pointCount = 10 , |
Qgis::PointCountMethod | method = Qgis::PointCountMethod::Absolute , |
||
double | densityArea = 250.0 , |
||
unsigned long | seed = 0 |
||
) |
Constructor for QgsRandomMarkerFillSymbolLayer, with the specified pointCount.
Optionally a specific random number seed can be used when generating points. A seed of 0 indicates that a truly random sequence will be used on every rendering, causing points to appear in different locations with every map refresh.
Definition at line 5014 of file qgsfillsymbollayer.cpp.
|
overridedefault |
|
overridevirtual |
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.
The default implementation returns false
.
Reimplemented from QgsSymbolLayer.
Definition at line 5250 of file qgsfillsymbollayer.cpp.
bool QgsRandomMarkerFillSymbolLayer::clipPoints | ( | ) | const |
Returns true
if point markers should be clipped to the polygon boundary.
Definition at line 5312 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 5236 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the "representative" color of the symbol layer.
Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally return the stroke color of the layer, while a fill symbol layer will return the "fill" color instead of stroke.
Some symbol layer types will return an invalid QColor if they have no representative color associated (e.g. raster image based symbol layers).
Reimplemented from QgsSymbolLayer.
Definition at line 5070 of file qgsfillsymbollayer.cpp.
Qgis::PointCountMethod QgsRandomMarkerFillSymbolLayer::countMethod | ( | ) | const |
Returns the count method used to randomly fill the polygon.
Definition at line 5322 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsRandomMarkerFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
Definition at line 5025 of file qgsfillsymbollayer.cpp.
double QgsRandomMarkerFillSymbolLayer::densityArea | ( | ) | const |
Returns the density area used to count the number of points to randomly fill the polygon.
Only used when the count method is set to QgsRandomMarkerFillSymbolLayer::DensityBasedCount.
Units are specified by setDensityAreaUnit().
Definition at line 5332 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the units for the density area.
Definition at line 2371 of file qgsfillsymbollayer.h.
|
inline |
Returns the map scale for the density area.
Definition at line 2388 of file qgsfillsymbollayer.h.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsSymbolLayer.
Definition at line 5283 of file qgsfillsymbollayer.cpp.
|
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 5059 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 5397 of file qgsfillsymbollayer.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 5371 of file qgsfillsymbollayer.cpp.
int QgsRandomMarkerFillSymbolLayer::pointCount | ( | ) | const |
Returns the count of random points to render in the fill.
Definition at line 5292 of file qgsfillsymbollayer.cpp.
|
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 5223 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.
The rings argument optionally specifies a list of polygon rings to render as holes.
Implements QgsFillSymbolLayer.
Definition at line 5085 of file qgsfillsymbollayer.cpp.
unsigned long QgsRandomMarkerFillSymbolLayer::seed | ( | ) | const |
Returns the random number seed to use when generating points, or 0 if a truly random sequence will be used (causing points to appear in different locations with every map refresh).
Definition at line 5302 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setClipPoints | ( | bool | clipped | ) |
Sets whether point markers should be clipped to the polygon boundary.
Definition at line 5317 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets the "representative" color for the symbol layer.
Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally set the stroke color of the layer, while a fill symbol layer will set the "fill" color instead of stroke.
Reimplemented from QgsSymbolLayer.
Definition at line 5064 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setCountMethod | ( | Qgis::PointCountMethod | method | ) |
Sets the count method used to randomly fill the polygon.
Definition at line 5327 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setDensityArea | ( | double | area | ) |
Sets the density area used to count the number of points to randomly fill the polygon.
Definition at line 5337 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the units for the density area.
unit | width units |
Definition at line 2365 of file qgsfillsymbollayer.h.
|
inline |
Sets the map scale for the density area.
scale | density area map unit scale |
Definition at line 2380 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 5389 of file qgsfillsymbollayer.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 5362 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setPointCount | ( | int | count | ) |
Sets the count of random points to render in the fill.
Definition at line 5297 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setSeed | ( | unsigned long | seed | ) |
Sets the random number seed to use when generating points, or 0 if a truly random sequence will be used on every rendering (causing points to appear in different locations with every map refresh).
Definition at line 5307 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 5260 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Called before the layer will be rendered for a particular feature.
This is always followed by a call to stopFeatureRender() after the feature has been completely rendered (i.e. all parts have been rendered).
The default implementation does nothing.
Reimplemented from QgsSymbolLayer.
Definition at line 5342 of file qgsfillsymbollayer.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.
Definition at line 5075 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Called after the layer has been rendered for a particular feature.
This is always preceded by a call to startFeatureRender() just before the feature will be rendered.
The default implementation does nothing.
Reimplemented from QgsSymbolLayer.
Definition at line 5348 of file qgsfillsymbollayer.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 5080 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 5255 of file qgsfillsymbollayer.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 5273 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 5380 of file qgsfillsymbollayer.cpp.