QGIS API Documentation 3.35.0-Master (6cf940c20d6)
Loading...
Searching...
No Matches
Classes | Public Member Functions | Static Public Member Functions | List of all members
QgsRandomMarkerFillSymbolLayer Class Reference

A fill symbol layer which places markers at random locations within polygons. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsRandomMarkerFillSymbolLayer:
Inheritance graph
[legend]

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.
 
 ~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.
 
bool clipPoints () const
 Returns true if point markers should be clipped to the polygon boundary.
 
QgsRandomMarkerFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance.
 
QColor color () const override
 Returns the "representative" color of the symbol layer.
 
Qgis::PointCountMethod countMethod () const
 Returns the count method used to randomly fill the polygon.
 
double densityArea () const
 Returns the density area used to count the number of points to randomly fill the polygon.
 
Qgis::RenderUnit densityAreaUnit () const
 Returns the units for the density area.
 
const QgsMapUnitScaledensityAreaUnitScale () const
 Returns the map scale for the density area.
 
bool hasDataDefinedProperties () const override
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.
 
QString layerType () const override
 Returns a string that represents this layer type.
 
QgsMapUnitScale mapUnitScale () const override
 
Qgis::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer.
 
int pointCount () const
 Returns the count of random points to render in the fill.
 
QVariantMap properties () const override
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.
 
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.
 
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).
 
void setClipPoints (bool clipped)
 Sets whether point markers should be clipped to the polygon boundary.
 
void setColor (const QColor &color) override
 Sets the "representative" color for the symbol layer.
 
void setCountMethod (Qgis::PointCountMethod method)
 Sets the count method used to randomly fill the polygon.
 
void setDensityArea (double area)
 Sets the density area used to count the number of points to randomly fill the polygon.
 
void setDensityAreaUnit (Qgis::RenderUnit unit)
 Sets the units for the density area.
 
void setDensityAreaUnitScale (const QgsMapUnitScale &scale)
 Sets the map scale for the density area.
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer.
 
void setPointCount (int count)
 Sets the count of random points to render in the fill.
 
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).
 
bool setSubSymbol (QgsSymbol *symbol) FINAL
 Sets layer's subsymbol. takes ownership of the passed symbol.
 
void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override
 Called before the layer will be rendered for a particular feature.
 
void startRender (QgsSymbolRenderContext &context) override
 Called before a set of rendering operations commences on the supplied render context.
 
void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override
 Called after the layer has been rendered for a particular feature.
 
void stopRender (QgsSymbolRenderContext &context) override
 Called after a set of rendering operations has finished on the supplied render context.
 
QgsSymbolsubSymbol () override
 Returns the symbol's sub symbol, if present.
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns the set of attributes referenced by the layer.
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes.
 
- Public Member Functions inherited from QgsFillSymbolLayer
 QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied.
 
double angle () const
 Returns the rotation angle of the fill symbol, in degrees clockwise.
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
QgsFillSymbolLayeroperator= (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied.
 
void setAngle (double angle)
 Sets the rotation angle of the pattern, in degrees clockwise.
 
virtual QImage toTiledPatternImage () const
 Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills.
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied.
 
virtual ~QgsSymbolLayer ()
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 Gets angle.
 
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 dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets marker size.
 
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.
 
QString id () const
 Returns symbol layer identifier This id is unique in the whole project.
 
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 QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer.
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied.
 
QgsPaintEffectpaintEffect () 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.
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered.
 
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.
 
void setUserFlags (Qgis::SymbolLayerUserFlags flags)
 Sets user-controlled flags which control the symbol layer's behavior.
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer.
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD.
 
Qgis::SymbolType type () const
 
Qgis::SymbolLayerUserFlags userFlags () const
 Returns user-controlled flags which control the symbol layer's behavior.
 
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 QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsRandomMarkerFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions.
 

Additional Inherited Members

- Public Types inherited from QgsSymbolLayer
enum  Property {
  PropertySize = 0 , PropertyAngle , PropertyName , PropertyFillColor ,
  PropertyStrokeColor , PropertyStrokeWidth , PropertyStrokeStyle , PropertyOffset ,
  PropertyCharacter , PropertyWidth , PropertyHeight , PropertyPreserveAspectRatio ,
  PropertyFillStyle , PropertyJoinStyle , PropertySecondaryColor , PropertyLineAngle ,
  PropertyLineDistance , PropertyGradientType , PropertyCoordinateMode , PropertyGradientSpread ,
  PropertyGradientReference1X , PropertyGradientReference1Y , PropertyGradientReference2X , PropertyGradientReference2Y ,
  PropertyGradientReference1IsCentroid , PropertyGradientReference2IsCentroid , PropertyBlurRadius , PropertyShapeburstUseWholeShape ,
  PropertyShapeburstMaxDistance , PropertyShapeburstIgnoreRings , PropertyFile , PropertyDistanceX ,
  PropertyDistanceY , PropertyDisplacementX , PropertyDisplacementY , PropertyOpacity ,
  PropertyCustomDash , PropertyCapStyle , PropertyPlacement , PropertyInterval ,
  PropertyOffsetAlongLine , PropertyAverageAngleLength , PropertyHorizontalAnchor , PropertyVerticalAnchor ,
  PropertyLayerEnabled , PropertyArrowWidth , PropertyArrowStartWidth , PropertyArrowHeadLength ,
  PropertyArrowHeadThickness , PropertyArrowHeadType , PropertyArrowType , PropertyOffsetX ,
  PropertyOffsetY , PropertyPointCount , PropertyRandomSeed , PropertyClipPoints ,
  PropertyDensityArea , PropertyFontFamily , PropertyFontStyle , PropertyDashPatternOffset ,
  PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue ,
  PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX ,
  PropertyRandomOffsetY , PropertyLineClipping
}
 Data definable properties. More...
 
- 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.
 
- Protected Member Functions inherited from QgsSymbolLayer
 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 installMasks (QgsRenderContext &context, bool recursive)
 When rendering, install masks on context painter if recursive is true masks are installed recursively for all children symbol layers.
 
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 inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- 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< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 
Qgis::SymbolLayerUserFlags mUserFlags
 User controlled flags.
 
- Static Protected Attributes inherited from QgsSymbolLayer
static const bool SELECT_FILL_BORDER = false
 Whether fill styles for selected features also highlight symbol stroke.
 
static const bool SELECT_FILL_STYLE = false
 Whether fill styles for selected features uses symbol layer style.
 
static const bool SELECTION_IS_OPAQUE = true
 Whether styles for selected features ignore symbol alpha.
 

Detailed Description

A fill symbol layer which places markers at random locations within polygons.

Since
QGIS 3.12

Definition at line 2321 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsRandomMarkerFillSymbolLayer()

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 5461 of file qgsfillsymbollayer.cpp.

◆ ~QgsRandomMarkerFillSymbolLayer()

QgsRandomMarkerFillSymbolLayer::~QgsRandomMarkerFillSymbolLayer ( )
overridedefault

Member Function Documentation

◆ canCauseArtifactsBetweenAdjacentTiles()

bool QgsRandomMarkerFillSymbolLayer::canCauseArtifactsBetweenAdjacentTiles ( ) const
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.

Since
QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 5698 of file qgsfillsymbollayer.cpp.

◆ clipPoints()

bool QgsRandomMarkerFillSymbolLayer::clipPoints ( ) const

Returns true if point markers should be clipped to the polygon boundary.

See also
setClipPoints()

Definition at line 5760 of file qgsfillsymbollayer.cpp.

◆ clone()

QgsRandomMarkerFillSymbolLayer * QgsRandomMarkerFillSymbolLayer::clone ( ) const
overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayer.

Definition at line 5684 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsRandomMarkerFillSymbolLayer::color ( ) const
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).

See also
setColor()
strokeColor()
fillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 5517 of file qgsfillsymbollayer.cpp.

◆ countMethod()

Qgis::PointCountMethod QgsRandomMarkerFillSymbolLayer::countMethod ( ) const

Returns the count method used to randomly fill the polygon.

See also
setCountMethod()

Definition at line 5770 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsRandomMarkerFillSymbolLayer::create ( const QVariantMap &  properties = QVariantMap())
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 5472 of file qgsfillsymbollayer.cpp.

◆ densityArea()

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().

See also
setDensityArea()

Definition at line 5780 of file qgsfillsymbollayer.cpp.

◆ densityAreaUnit()

Qgis::RenderUnit QgsRandomMarkerFillSymbolLayer::densityAreaUnit ( ) const
inline

Returns the units for the density area.

See also
setDensityAreaUnit()

Definition at line 2453 of file qgsfillsymbollayer.h.

◆ densityAreaUnitScale()

const QgsMapUnitScale & QgsRandomMarkerFillSymbolLayer::densityAreaUnitScale ( ) const
inline

Returns the map scale for the density area.

See also
setDensityAreaUnitScale()
densityArea()
densityAreaUnit()

Definition at line 2470 of file qgsfillsymbollayer.h.

◆ hasDataDefinedProperties()

bool QgsRandomMarkerFillSymbolLayer::hasDataDefinedProperties ( ) const
overridevirtual

Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.

Since
QGIS 3.4.5

Reimplemented from QgsSymbolLayer.

Definition at line 5731 of file qgsfillsymbollayer.cpp.

◆ layerType()

QString QgsRandomMarkerFillSymbolLayer::layerType ( ) const
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 5506 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsRandomMarkerFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 5849 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsRandomMarkerFillSymbolLayer::outputUnit ( ) const
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.

Returns
output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
See also
setOutputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 5823 of file qgsfillsymbollayer.cpp.

◆ pointCount()

int QgsRandomMarkerFillSymbolLayer::pointCount ( ) const

Returns the count of random points to render in the fill.

See also
setPointCount()

Definition at line 5740 of file qgsfillsymbollayer.cpp.

◆ properties()

QVariantMap QgsRandomMarkerFillSymbolLayer::properties ( ) const
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 5671 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsRandomMarkerFillSymbolLayer::renderPolygon ( const QPolygonF &  points,
const QVector< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
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 5532 of file qgsfillsymbollayer.cpp.

◆ seed()

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).

See also
setSeed()

Definition at line 5750 of file qgsfillsymbollayer.cpp.

◆ setClipPoints()

void QgsRandomMarkerFillSymbolLayer::setClipPoints ( bool  clipped)

Sets whether point markers should be clipped to the polygon boundary.

See also
clipPoints()

Definition at line 5765 of file qgsfillsymbollayer.cpp.

◆ setColor()

void QgsRandomMarkerFillSymbolLayer::setColor ( const QColor &  color)
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.

See also
color()
setStrokeColor()
setFillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 5511 of file qgsfillsymbollayer.cpp.

◆ setCountMethod()

void QgsRandomMarkerFillSymbolLayer::setCountMethod ( Qgis::PointCountMethod  method)

Sets the count method used to randomly fill the polygon.

See also
countMethod()

Definition at line 5775 of file qgsfillsymbollayer.cpp.

◆ setDensityArea()

void QgsRandomMarkerFillSymbolLayer::setDensityArea ( double  area)

Sets the density area used to count the number of points to randomly fill the polygon.

See also
densityArea()

Definition at line 5785 of file qgsfillsymbollayer.cpp.

◆ setDensityAreaUnit()

void QgsRandomMarkerFillSymbolLayer::setDensityAreaUnit ( Qgis::RenderUnit  unit)
inline

Sets the units for the density area.

Parameters
unitwidth units
See also
densityAreaUnit()

Definition at line 2447 of file qgsfillsymbollayer.h.

◆ setDensityAreaUnitScale()

void QgsRandomMarkerFillSymbolLayer::setDensityAreaUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map scale for the density area.

Parameters
scaledensity area map unit scale
See also
densityAreaUnitScale()
setDensityArea()
setDensityAreaUnit()

Definition at line 2462 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsRandomMarkerFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 5841 of file qgsfillsymbollayer.cpp.

◆ setOutputUnit()

void QgsRandomMarkerFillSymbolLayer::setOutputUnit ( Qgis::RenderUnit  unit)
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.

Parameters
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 5814 of file qgsfillsymbollayer.cpp.

◆ setPointCount()

void QgsRandomMarkerFillSymbolLayer::setPointCount ( int  count)

Sets the count of random points to render in the fill.

See also
pointCount()

Definition at line 5745 of file qgsfillsymbollayer.cpp.

◆ setSeed()

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).

See also
seed()

Definition at line 5755 of file qgsfillsymbollayer.cpp.

◆ setSubSymbol()

bool QgsRandomMarkerFillSymbolLayer::setSubSymbol ( QgsSymbol symbol)
virtual

Sets layer's subsymbol. takes ownership of the passed symbol.

Reimplemented from QgsSymbolLayer.

Definition at line 5708 of file qgsfillsymbollayer.cpp.

◆ startFeatureRender()

void QgsRandomMarkerFillSymbolLayer::startFeatureRender ( const QgsFeature feature,
QgsRenderContext context 
)
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.

Note
In some circumstances, startFeatureRender() and stopFeatureRender() may not be called before a symbol layer is rendered. E.g., when a symbol layer is being rendered in isolation and not as a result of rendering a feature (for instance, when rendering a legend patch or other non-feature based shape).
See also
stopFeatureRender()
startRender()
Since
QGIS 3.12

Reimplemented from QgsSymbolLayer.

Definition at line 5790 of file qgsfillsymbollayer.cpp.

◆ startRender()

void QgsRandomMarkerFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
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.

See also
startFeatureRender()
stopRender()

Implements QgsSymbolLayer.

Definition at line 5522 of file qgsfillsymbollayer.cpp.

◆ stopFeatureRender()

void QgsRandomMarkerFillSymbolLayer::stopFeatureRender ( const QgsFeature feature,
QgsRenderContext context 
)
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.

Note
In some circumstances, startFeatureRender() and stopFeatureRender() may not be called before a symbol layer is rendered. E.g., when a symbol layer is being rendered in isolation and not as a result of rendering a feature (for instance, when rendering a legend patch or other non-feature based shape).
See also
startFeatureRender()
stopRender()
Since
QGIS 3.12

Reimplemented from QgsSymbolLayer.

Definition at line 5798 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsRandomMarkerFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
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.

See also
startRender()
stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 5527 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsRandomMarkerFillSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 5703 of file qgsfillsymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsRandomMarkerFillSymbolLayer::usedAttributes ( const QgsRenderContext context) const
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 5721 of file qgsfillsymbollayer.cpp.

◆ usesMapUnits()

bool QgsRandomMarkerFillSymbolLayer::usesMapUnits ( ) const
overridevirtual

Returns true if the symbol layer has any components which use map unit based sizes.

Since
QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 5832 of file qgsfillsymbollayer.cpp.


The documentation for this class was generated from the following files: