QGIS API Documentation
3.22.4-Białowieża (ce8e65e95e)
|
A fill symbol layer which places markers at random locations within polygons. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsRandomMarkerFillSymbolLayer (int pointCount=10, CountMethod method=AbsoluteCount, 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 |
The fill color. More... | |
CountMethod | 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 |
The fill color. More... | |
void | setCountMethod (CountMethod 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... | |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
virtual | ~QgsSymbolLayer () |
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 |
Gets fill color. More... | |
virtual Qgis::SymbolLayerFlags | flags () const |
Returns flags which control the symbol layer's behavior. 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 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... | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. 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) |
Set fill color. 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) |
Set stroke color. More... | |
virtual QColor | strokeColor () const |
Gets stroke color. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const |
Saves the symbol layer as SLD. More... | |
Qgis::SymbolType | type () const |
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... | |
Additional Inherited Members | |
Protected Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) |
Default method to render polygon. More... | |
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 inherited from QgsFillSymbolLayer | |
double | mAngle = 0.0 |
Protected Attributes inherited from QgsSymbolLayer | |
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 |
Static Protected Attributes inherited from QgsSymbolLayer | |
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... | |
A fill symbol layer which places markers at random locations within polygons.
Definition at line 1833 of file qgsfillsymbollayer.h.
Methods to define the number of points randomly filling the polygon.
Enumerator | |
---|---|
AbsoluteCount | The point count is used as an absolute count of markers. |
DensityBasedCount | The point count is part of a marker density count. |
Definition at line 1838 of file qgsfillsymbollayer.h.
QgsRandomMarkerFillSymbolLayer::QgsRandomMarkerFillSymbolLayer | ( | int | pointCount = 10 , |
CountMethod | method = AbsoluteCount , |
||
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 4453 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 4689 of file qgsfillsymbollayer.cpp.
bool QgsRandomMarkerFillSymbolLayer::clipPoints | ( | ) | const |
Returns true
if point markers should be clipped to the polygon boundary.
Definition at line 4751 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 4675 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 4509 of file qgsfillsymbollayer.cpp.
QgsRandomMarkerFillSymbolLayer::CountMethod QgsRandomMarkerFillSymbolLayer::countMethod | ( | ) | const |
Returns the count method used to randomly fill the polygon.
Definition at line 4761 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 4464 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 4771 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the units for the density area.
Definition at line 1972 of file qgsfillsymbollayer.h.
|
inline |
Returns the map scale for the density area.
Definition at line 1989 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 4722 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 4498 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 4835 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 4809 of file qgsfillsymbollayer.cpp.
int QgsRandomMarkerFillSymbolLayer::pointCount | ( | ) | const |
Returns the count of random points to render in the fill.
Definition at line 4731 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 4662 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 4524 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 4741 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setClipPoints | ( | bool | clipped | ) |
Sets whether point markers should be clipped to the polygon boundary.
Definition at line 4756 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 4503 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setCountMethod | ( | CountMethod | method | ) |
Sets the count method used to randomly fill the polygon.
Definition at line 4766 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 4776 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the units for the density area.
unit | width units |
Definition at line 1966 of file qgsfillsymbollayer.h.
|
inline |
Sets the map scale for the density area.
scale | density area map unit scale |
Definition at line 1981 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 4827 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 4801 of file qgsfillsymbollayer.cpp.
void QgsRandomMarkerFillSymbolLayer::setPointCount | ( | int | count | ) |
Sets the count of random points to render in the fill.
Definition at line 4736 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 4746 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 4699 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 4781 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 4514 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 4787 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 4519 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 4694 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 4712 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 4818 of file qgsfillsymbollayer.cpp.