A fill symbol layer which fills polygon shapes with repeating marker symbols. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsPointPatternFillSymbolLayer:

Public Member Functions
	QgsPointPatternFillSymbolLayer ()

	~QgsPointPatternFillSymbolLayer () override

Qgis::MarkerClipMode	clipMode () const
	Returns the marker clipping mode, which defines how markers are clipped at the edges of shapes. More...

QgsPointPatternFillSymbolLayer *	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...

double	displacementX () const
	Returns the horizontal displacement for odd numbered rows in the pattern. More...

const QgsMapUnitScale &	displacementXMapUnitScale () const
	Returns the map unit scale for the horizontal displacement between odd numbered rows in the pattern. More...

Qgis::RenderUnit	displacementXUnit () const
	Returns the units for the horizontal displacement between rows in the pattern. More...

double	displacementY () const
	Returns the vertical displacement for odd numbered columns in the pattern. More...

const QgsMapUnitScale &	displacementYMapUnitScale () const
	Returns the map unit scale for the vertical displacement between odd numbered columns in the pattern. More...

Qgis::RenderUnit	displacementYUnit () const
	Returns the units for the vertical displacement between rows in the pattern. More...

double	distanceX () const
	Returns the horizontal distance between rendered markers in the fill. More...

const QgsMapUnitScale &	distanceXMapUnitScale () const
	Returns the map unit scale for the horizontal distance between points in the pattern. More...

Qgis::RenderUnit	distanceXUnit () const
	Returns the units for the horizontal distance between points in the pattern. More...

double	distanceY () const
	Returns the vertical distance between rendered markers in the fill. More...

const QgsMapUnitScale &	distanceYMapUnitScale () const
	Returns the map unit scale for the vertical distance between points in the pattern. More...

Qgis::RenderUnit	distanceYUnit () const
	Returns the units for the vertical distance between points in the pattern. More...

double	estimateMaxBleed (const QgsRenderContext &context) const override
	Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. 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

double	maximumRandomDeviationX () const
	Returns the maximum horizontal random deviation of points in the pattern. More...

double	maximumRandomDeviationY () const
	Returns the maximum vertical random deviation of points in the pattern. More...

double	offsetX () const
	Returns the horizontal offset values for points in the pattern. More...

const QgsMapUnitScale &	offsetXMapUnitScale () const
	Returns the unit scale for the horizontal offset for rows in the pattern. More...

Qgis::RenderUnit	offsetXUnit () const
	Returns the units for the horizontal offset for rows in the pattern. More...

double	offsetY () const
	Returns the vertical offset values for points in the pattern. More...

const QgsMapUnitScale &	offsetYMapUnitScale () const
	Returns the unit scale for the vertical offset between rows in the pattern. More...

Qgis::RenderUnit	offsetYUnit () const
	Returns the units for the vertical offset for rows in the pattern. More...

Qgis::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer. 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...

const QgsMapUnitScale &	randomDeviationXMapUnitScale () const
	Returns the unit scale for the horizontal random deviation of points in the pattern. More...

Qgis::RenderUnit	randomDeviationXUnit () const
	Returns the units for the horizontal random deviation of points in the pattern. More...

const QgsMapUnitScale &	randomDeviationYMapUnitScale () const
	Returns the unit scale for the vertical random deviation of points in the pattern. More...

Qgis::RenderUnit	randomDeviationYUnit () const
	Returns the units for the vertical random deviation of points in the pattern. 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 randomly shifting points, or 0 if a truly random sequence will be used (causing points to appear in different locations with every map refresh). More...

void	setClipMode (Qgis::MarkerClipMode mode)
	Sets the marker clipping mode, which defines how markers are clipped at the edges of shapes. More...

void	setColor (const QColor &c) override
	Sets the "representative" color for the symbol layer. More...

void	setDisplacementX (double d)
	Sets the horizontal displacement for odd numbered rows in the pattern. More...

void	setDisplacementXMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the horizontal displacement between odd numbered rows in the pattern. More...

void	setDisplacementXUnit (Qgis::RenderUnit unit)
	Sets the units for the horizontal displacement between rows in the pattern. More...

void	setDisplacementY (double d)
	Sets the vertical displacement for odd numbered columns in the pattern. More...

void	setDisplacementYMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the vertical displacement between odd numbered columns in the pattern. More...

void	setDisplacementYUnit (Qgis::RenderUnit unit)
	Sets the units for the vertical displacement between rows in the pattern. More...

void	setDistanceX (double d)
	Sets the horizontal distance between rendered markers in the fill. More...

void	setDistanceXMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the horizontal distance between points in the pattern. More...

void	setDistanceXUnit (Qgis::RenderUnit unit)
	Sets the unit for the horizontal distance between points in the pattern. More...

void	setDistanceY (double d)
	Sets the vertical distance between rendered markers in the fill. More...

void	setDistanceYMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the vertical distance between points in the pattern. More...

void	setDistanceYUnit (Qgis::RenderUnit unit)
	Sets the unit for the vertical distance between points in the pattern. More...

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setMaximumRandomDeviationX (double deviation)
	Sets the maximum horizontal random deviation of points in the pattern. More...

void	setMaximumRandomDeviationY (double deviation)
	Sets the maximum vertical random deviation of points in the pattern. More...

void	setOffsetX (double offset)
	Sets the horizontal offset values for points in the pattern. More...

void	setOffsetXMapUnitScale (const QgsMapUnitScale &scale)
	Sets the unit scale for the horizontal offset for rows in the pattern. More...

void	setOffsetXUnit (Qgis::RenderUnit unit)
	Sets the units for the horizontal offset between rows in the pattern. More...

void	setOffsetY (double offset)
	Sets the vertical offset values for points in the pattern. More...

void	setOffsetYMapUnitScale (const QgsMapUnitScale &scale)
	Sets the unit scale for the vertical offset for rows in the pattern. More...

void	setOffsetYUnit (Qgis::RenderUnit unit)
	Sets the units for the vertical offset for rows in the pattern. More...

void	setOutputUnit (Qgis::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer. More...

void	setRandomDeviationXMapUnitScale (const QgsMapUnitScale &scale)
	Sets the unit scale for the horizontal random deviation of points in the pattern. More...

void	setRandomDeviationXUnit (Qgis::RenderUnit unit)
	Sets the unit for the horizontal random deviation of points in the pattern. More...

void	setRandomDeviationYMapUnitScale (const QgsMapUnitScale &scale)
	Sets the unit scale for the vertical random deviation of points in the pattern. More...

void	setRandomDeviationYUnit (Qgis::RenderUnit unit)
	Sets the unit for the vertical random deviation of points in the pattern. More...

void	setSeed (unsigned long seed)
	Sets the random number seed to use when randomly shifting 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...

void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
	Saves the symbol layer as SLD. More...

QImage	toTiledPatternImage () const override
	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. 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 QgsImageFillSymbolLayer
	QgsImageFillSymbolLayer ()

	~QgsImageFillSymbolLayer () override

Qgis::SymbolCoordinateReference	coordinateReference () const
	Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. More...

Qt::PenStyle	dxfPenStyle () const override
	Gets pen style. More...

double	dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
	Gets line width. More...

QgsMapUnitScale	mapUnitScale () const override

Qgis::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer. 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...

void	setCoordinateReference (Qgis::SymbolCoordinateReference coordinateReference)
	Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. More...

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

void	setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
	Sets the stroke width map unit scale. More...

void	setStrokeWidthUnit (Qgis::RenderUnit unit)
	Sets the units fo the symbol's stroke width. More...

const QgsMapUnitScale &	strokeWidthMapUnitScale () const
	Returns the stroke width map unit scale. More...

Qgis::RenderUnit	strokeWidthUnit () const
	Returns the units for the symbol's stroke width. More...

Public Member Functions inherited from QgsFillSymbolLayer
	QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete
	QgsFillSymbolLayer cannot be copied. More...

double	angle () const
	Returns the rotation angle of the fill symbol, in degrees clockwise. More...

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)
	Sets the rotation angle of the pattern, in degrees clockwise. More...

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

Public Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete
	QgsSymbolLayer cannot be copied. More...

virtual	~QgsSymbolLayer ()

virtual bool	canCauseArtifactsBetweenAdjacentTiles () const
	Returns `true` if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry. More...

virtual QgsSymbolLayer *	clone () const =0
	Shall be reimplemented by subclasses to create a deep copy of the instance. More...

virtual QColor	color () const
	Returns the "representative" color of the symbol layer. More...

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the symbol layer's property collection, used for data defined overrides. More...

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the symbol layer's property collection, used for data defined overrides. More...

virtual void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0

virtual double	dxfAngle (QgsSymbolRenderContext &context) const
	Gets angle. More...

virtual QColor	dxfBrushColor (QgsSymbolRenderContext &context) const
	Gets brush/fill color. More...

virtual Qt::BrushStyle	dxfBrushStyle () const
	Gets brush/fill style. More...

virtual QColor	dxfColor (QgsSymbolRenderContext &context) const
	Gets color. More...

virtual QVector< qreal >	dxfCustomDashPattern (Qgis::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	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets marker size. 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...

QString	id () const
	Returns symbol layer identifier This id is unique in the whole project. 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 Qgis::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	setId (const QString &id)
	Set symbol layer identifier This id has to be unique in the whole project. More...

void	setLocked (bool locked)
	Sets whether the layer's colors are locked. More...

virtual void	setMapUnitScale (const QgsMapUnitScale &scale)

virtual void	setOutputUnit (Qgis::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 QgsPointPatternFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More...

static QgsSymbolLayer *	createFromSld (QDomElement &element)

Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions. More...

Protected Member Functions
void	applyDataDefinedSettings (QgsSymbolRenderContext &context) override
	Applies data defined settings prior to generating the fill symbol brush. More...

Protected Member Functions inherited from QgsImageFillSymbolLayer
virtual bool	applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const
	Returns `true` if the image brush should be transformed using the render context's texture origin. More...

virtual void	applyDataDefinedSettings (QgsSymbolRenderContext &context)
	Applies data defined settings prior to generating the fill symbol brush. 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. 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	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. More...

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

void	restoreOldDataDefinedProperties (const QVariantMap &stringMap)
	Restores older data defined properties from string map. More...

Protected Attributes
double	mDisplacementX = 0

QgsMapUnitScale	mDisplacementXMapUnitScale

Qgis::RenderUnit	mDisplacementXUnit = Qgis::RenderUnit::Millimeters

double	mDisplacementY = 0

QgsMapUnitScale	mDisplacementYMapUnitScale

Qgis::RenderUnit	mDisplacementYUnit = Qgis::RenderUnit::Millimeters

double	mDistanceX = 15

QgsMapUnitScale	mDistanceXMapUnitScale

Qgis::RenderUnit	mDistanceXUnit = Qgis::RenderUnit::Millimeters

double	mDistanceY = 15

QgsMapUnitScale	mDistanceYMapUnitScale

Qgis::RenderUnit	mDistanceYUnit = Qgis::RenderUnit::Millimeters

std::unique_ptr< QgsMarkerSymbol >	mMarkerSymbol

double	mOffsetX = 0

QgsMapUnitScale	mOffsetXMapUnitScale

Qgis::RenderUnit	mOffsetXUnit = Qgis::RenderUnit::Millimeters

double	mOffsetY = 0

QgsMapUnitScale	mOffsetYMapUnitScale

Qgis::RenderUnit	mOffsetYUnit = Qgis::RenderUnit::Millimeters

double	mRandomDeviationX = 0

QgsMapUnitScale	mRandomDeviationXMapUnitScale

Qgis::RenderUnit	mRandomDeviationXUnit = Qgis::RenderUnit::Millimeters

double	mRandomDeviationY = 0

QgsMapUnitScale	mRandomDeviationYMapUnitScale

Qgis::RenderUnit	mRandomDeviationYUnit = Qgis::RenderUnit::Millimeters

unsigned long	mSeed = 0

Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush	mBrush

Qgis::SymbolCoordinateReference	mCoordinateReference = Qgis::SymbolCoordinateReference::Feature

double	mNextAngle = 0.0

double	mStrokeWidth = 0.0
	Stroke width. More...

QgsMapUnitScale	mStrokeWidthMapUnitScale

Qgis::RenderUnit	mStrokeWidthUnit = Qgis::RenderUnit::Millimeters

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

QgsFields	mFields

QString	mId

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

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

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

Detailed Description

A fill symbol layer which fills polygon shapes with repeating marker symbols.

Definition at line 1678 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsPointPatternFillSymbolLayer()

QgsPointPatternFillSymbolLayer::QgsPointPatternFillSymbolLayer ( )

Definition at line 3572 of file qgsfillsymbollayer.cpp.

◆ ~QgsPointPatternFillSymbolLayer()

QgsPointPatternFillSymbolLayer::~QgsPointPatternFillSymbolLayer ( )

overridedefault

Member Function Documentation

◆ applyDataDefinedSettings()

void QgsPointPatternFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext & context )

overrideprotectedvirtual

Applies data defined settings prior to generating the fill symbol brush.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 4633 of file qgsfillsymbollayer.cpp.

◆ clipMode()

Qgis::MarkerClipMode QgsPointPatternFillSymbolLayer::clipMode ( ) const

inline

Returns the marker clipping mode, which defines how markers are clipped at the edges of shapes.

See also: setClipMode()

Since: QGIS 3.24

Definition at line 2035 of file qgsfillsymbollayer.h.

◆ clone()

QgsPointPatternFillSymbolLayer * QgsPointPatternFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 4330 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsPointPatternFillSymbolLayer::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 4713 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsPointPatternFillSymbolLayer::create ( const QVariantMap & properties = QVariantMap() )

static

Creates a new QgsPointPatternFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

Caller takes ownership of the returned symbol layer.

Definition at line 3664 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsPointPatternFillSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 4465 of file qgsfillsymbollayer.cpp.

◆ displacementX()

double QgsPointPatternFillSymbolLayer::displacementX ( ) const

inline

Returns the horizontal displacement for odd numbered rows in the pattern.

Units are retrieved via displacementXUnit().

See also: setDisplacementX(); displacementXUnit(); displacementXMapUnitScale()

Definition at line 1830 of file qgsfillsymbollayer.h.

◆ displacementXMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::displacementXMapUnitScale ( ) const

inline

Returns the map unit scale for the horizontal displacement between odd numbered rows in the pattern.

See also: setDisplacementXMapUnitScale(); displacementX()

Definition at line 1872 of file qgsfillsymbollayer.h.

◆ displacementXUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::displacementXUnit ( ) const

inline

Returns the units for the horizontal displacement between rows in the pattern.

See also: setDisplacementXUnit(); displacementYUnit()

Definition at line 1856 of file qgsfillsymbollayer.h.

◆ displacementY()

double QgsPointPatternFillSymbolLayer::displacementY ( ) const

inline

Returns the vertical displacement for odd numbered columns in the pattern.

Units are retrieved via displacementYUnit().

See also: setDisplacementY(); displacementYUnit(); displacementYMapUnitScale()

Definition at line 1883 of file qgsfillsymbollayer.h.

◆ displacementYMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::displacementYMapUnitScale ( ) const

inline

Returns the map unit scale for the vertical displacement between odd numbered columns in the pattern.

See also: setDisplacementYMapUnitScale(); displacementY()

Definition at line 1925 of file qgsfillsymbollayer.h.

◆ displacementYUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::displacementYUnit ( ) const

inline

Returns the units for the vertical displacement between rows in the pattern.

See also: setDisplacementYUnit(); displacementXUnit()

Definition at line 1909 of file qgsfillsymbollayer.h.

◆ distanceX()

double QgsPointPatternFillSymbolLayer::distanceX ( ) const

inline

Returns the horizontal distance between rendered markers in the fill.

Units are retrieved via distanceXUnit().

See also: setDistanceX(); distanceXUnit(); distanceXMapUnitScale()

Definition at line 1724 of file qgsfillsymbollayer.h.

◆ distanceXMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::distanceXMapUnitScale ( ) const

inline

Returns the map unit scale for the horizontal distance between points in the pattern.

See also: setDistanceXMapUnitScale(); distanceX()

Definition at line 1766 of file qgsfillsymbollayer.h.

◆ distanceXUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::distanceXUnit ( ) const

inline

Returns the units for the horizontal distance between points in the pattern.

See also: setDistanceXUnit(); distanceYUnit()

Definition at line 1750 of file qgsfillsymbollayer.h.

◆ distanceY()

double QgsPointPatternFillSymbolLayer::distanceY ( ) const

inline

Returns the vertical distance between rendered markers in the fill.

Units are retrieved via distanceYUnit().

See also: setDistanceY(); distanceYUnit(); distanceYMapUnitScale()

Definition at line 1777 of file qgsfillsymbollayer.h.

◆ distanceYMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::distanceYMapUnitScale ( ) const

inline

Returns the map unit scale for the vertical distance between points in the pattern.

See also: setDistanceYMapUnitScale(); distanceY()

Definition at line 1819 of file qgsfillsymbollayer.h.

◆ distanceYUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::distanceYUnit ( ) const

inline

Returns the units for the vertical distance between points in the pattern.

See also: setDistanceYUnit(); distanceXUnit()

Definition at line 1803 of file qgsfillsymbollayer.h.

◆ estimateMaxBleed()

double QgsPointPatternFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext & context ) const

overridevirtual

Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.

For example, polygons drawn with an stroke will draw half the width of the stroke outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.

Reimplemented from QgsSymbolLayer.

Definition at line 4682 of file qgsfillsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsPointPatternFillSymbolLayer::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 4697 of file qgsfillsymbollayer.cpp.

◆ layerType()

QString QgsPointPatternFillSymbolLayer::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 3806 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3648 of file qgsfillsymbollayer.cpp.

◆ maximumRandomDeviationX()

double QgsPointPatternFillSymbolLayer::maximumRandomDeviationX ( ) const

inline

Returns the maximum horizontal random deviation of points in the pattern.

Units are retrieved via maximumRandomDeviationXUnit().

See also: setMaximumRandomDeviationX(); maximumRandomDeviationY()

Since: QGIS 3.24

Definition at line 2065 of file qgsfillsymbollayer.h.

◆ maximumRandomDeviationY()

double QgsPointPatternFillSymbolLayer::maximumRandomDeviationY ( ) const

inline

Returns the maximum vertical random deviation of points in the pattern.

Units are retrieved via maximumRandomDeviationYUnit().

See also: setMaximumRandomDeviationY(); maximumRandomDeviationX()

Since: QGIS 3.24

Definition at line 2087 of file qgsfillsymbollayer.h.

◆ offsetX()

double QgsPointPatternFillSymbolLayer::offsetX ( ) const

inline

Returns the horizontal offset values for points in the pattern.

See also: setOffsetX(); offsetY()

Since: QGIS 3.8

Definition at line 1942 of file qgsfillsymbollayer.h.

◆ offsetXMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::offsetXMapUnitScale ( ) const

inline

Returns the unit scale for the horizontal offset for rows in the pattern.

See also: setOffsetXMapUnitScale(); offsetYMapUnitScale()

Since: QGIS 3.8

Definition at line 1993 of file qgsfillsymbollayer.h.

◆ offsetXUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::offsetXUnit ( ) const

inline

Returns the units for the horizontal offset for rows in the pattern.

See also: setOffsetXUnit(); offsetYUnit()

Since: QGIS 3.8

Definition at line 1976 of file qgsfillsymbollayer.h.

◆ offsetY()

double QgsPointPatternFillSymbolLayer::offsetY ( ) const

inline

Returns the vertical offset values for points in the pattern.

See also: setOffsetY(); offsetX()

Since: QGIS 3.8

Definition at line 1959 of file qgsfillsymbollayer.h.

◆ offsetYMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::offsetYMapUnitScale ( ) const

inline

Returns the unit scale for the vertical offset between rows in the pattern.

See also: setOffsetYMapUnitScale(); offsetXMapUnitScale()

Since: QGIS 3.8

Definition at line 2027 of file qgsfillsymbollayer.h.

◆ offsetYUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::offsetYUnit ( ) const

inline

Returns the units for the vertical offset for rows in the pattern.

See also: setOffsetYUnit(); offsetXUnit()

Since: QGIS 3.8

Definition at line 2010 of file qgsfillsymbollayer.h.

◆ outputUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::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 QgsImageFillSymbolLayer.

Definition at line 3606 of file qgsfillsymbollayer.cpp.

◆ properties()

QVariantMap QgsPointPatternFillSymbolLayer::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.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 4295 of file qgsfillsymbollayer.cpp.

◆ randomDeviationXMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::randomDeviationXMapUnitScale ( ) const

inline

Returns the unit scale for the horizontal random deviation of points in the pattern.

See also: setRandomDeviationXMapUnitScale(); randomDeviationYMapUnitScale()

Since: QGIS 3.24

Definition at line 2133 of file qgsfillsymbollayer.h.

◆ randomDeviationXUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::randomDeviationXUnit ( ) const

inline

Returns the units for the horizontal random deviation of points in the pattern.

See also: setRandomDeviationXUnit(); randomDeviationYUnit()

Since: QGIS 3.24

Definition at line 2105 of file qgsfillsymbollayer.h.

◆ randomDeviationYMapUnitScale()

const QgsMapUnitScale & QgsPointPatternFillSymbolLayer::randomDeviationYMapUnitScale ( ) const

inline

Returns the unit scale for the vertical random deviation of points in the pattern.

See also: setRandomDeviationXMapUnitScale(); randomDeviationXMapUnitScale()

Since: QGIS 3.24

Definition at line 2142 of file qgsfillsymbollayer.h.

◆ randomDeviationYUnit()

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::randomDeviationYUnit ( ) const

inline

Returns the units for the vertical random deviation of points in the pattern.

See also: setRandomDeviationYUnit(); randomDeviationXUnit()

Since: QGIS 3.24

Definition at line 2124 of file qgsfillsymbollayer.h.

◆ renderPolygon()

void QgsPointPatternFillSymbolLayer::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.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3960 of file qgsfillsymbollayer.cpp.

◆ seed()

unsigned long QgsPointPatternFillSymbolLayer::seed ( ) const

inline

Returns the random number seed to use when randomly shifting 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()

Since: QGIS 3.24

Definition at line 2168 of file qgsfillsymbollayer.h.

◆ setClipMode()

void QgsPointPatternFillSymbolLayer::setClipMode ( Qgis::MarkerClipMode mode )

inline

Sets the marker clipping mode, which defines how markers are clipped at the edges of shapes.

See also: clipMode()

Since: QGIS 3.24

Definition at line 2043 of file qgsfillsymbollayer.h.

◆ setColor()

void QgsPointPatternFillSymbolLayer::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 4706 of file qgsfillsymbollayer.cpp.

◆ setDisplacementX()

void QgsPointPatternFillSymbolLayer::setDisplacementX ( double d )

inline

Sets the horizontal displacement for odd numbered rows in the pattern.

Units are set via setDisplacementXUnit().

See also: displacementX(); setDisplacementXUnit(); setDisplacementXMapUnitScale()

Definition at line 1841 of file qgsfillsymbollayer.h.

◆ setDisplacementXMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDisplacementXMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the horizontal displacement between odd numbered rows in the pattern.

See also: displacementXMapUnitScale(); setDisplacementX()

Definition at line 1864 of file qgsfillsymbollayer.h.

◆ setDisplacementXUnit()

void QgsPointPatternFillSymbolLayer::setDisplacementXUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the horizontal displacement between rows in the pattern.

Parameters

unit	displacement units

See also: displacementXUnit(); setDisplacementYUnit()

Definition at line 1849 of file qgsfillsymbollayer.h.

◆ setDisplacementY()

void QgsPointPatternFillSymbolLayer::setDisplacementY ( double d )

inline

Sets the vertical displacement for odd numbered columns in the pattern.

Units are set via setDisplacementYUnit().

See also: displacementY(); setDisplacementYUnit(); setDisplacementYMapUnitScale()

Definition at line 1894 of file qgsfillsymbollayer.h.

◆ setDisplacementYMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDisplacementYMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the vertical displacement between odd numbered columns in the pattern.

See also: displacementYMapUnitScale(); setDisplacementY()

Definition at line 1917 of file qgsfillsymbollayer.h.

◆ setDisplacementYUnit()

void QgsPointPatternFillSymbolLayer::setDisplacementYUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the vertical displacement between rows in the pattern.

Parameters

unit	displacement units

See also: displacementYUnit(); setDisplacementXUnit()

Definition at line 1902 of file qgsfillsymbollayer.h.

◆ setDistanceX()

void QgsPointPatternFillSymbolLayer::setDistanceX ( double d )

inline

Sets the horizontal distance between rendered markers in the fill.

Units are set via setDistanceXUnit().

See also: distanceX(); setDistanceXUnit(); setDistanceXMapUnitScale()

Definition at line 1735 of file qgsfillsymbollayer.h.

◆ setDistanceXMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDistanceXMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the horizontal distance between points in the pattern.

See also: distanceXMapUnitScale(); setDistanceX()

Definition at line 1758 of file qgsfillsymbollayer.h.

◆ setDistanceXUnit()

void QgsPointPatternFillSymbolLayer::setDistanceXUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the horizontal distance between points in the pattern.

Parameters

unit	distance units

See also: distanceXUnit(); setDistanceYUnit()

Definition at line 1743 of file qgsfillsymbollayer.h.

◆ setDistanceY()

void QgsPointPatternFillSymbolLayer::setDistanceY ( double d )

inline

Sets the vertical distance between rendered markers in the fill.

Units are set via setDistanceYUnit().

See also: distanceY(); setDistanceYUnit(); setDistanceYMapUnitScale()

Definition at line 1788 of file qgsfillsymbollayer.h.

◆ setDistanceYMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDistanceYMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the vertical distance between points in the pattern.

See also: distanceYMapUnitScale(); setDistanceY()

Definition at line 1811 of file qgsfillsymbollayer.h.

◆ setDistanceYUnit()

void QgsPointPatternFillSymbolLayer::setDistanceYUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the vertical distance between points in the pattern.

Parameters

unit	distance units

See also: distanceYUnit(); setDistanceXUnit()

Definition at line 1796 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsPointPatternFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3635 of file qgsfillsymbollayer.cpp.

◆ setMaximumRandomDeviationX()

void QgsPointPatternFillSymbolLayer::setMaximumRandomDeviationX ( double deviation )

inline

Sets the maximum horizontal random deviation of points in the pattern.

Units are set via setMaximumRandomDeviationXUnit().

See also: maximumRandomDeviationX(); setMaximumRandomDeviationY()

Since: QGIS 3.24

Definition at line 2054 of file qgsfillsymbollayer.h.

◆ setMaximumRandomDeviationY()

void QgsPointPatternFillSymbolLayer::setMaximumRandomDeviationY ( double deviation )

inline

Sets the maximum vertical random deviation of points in the pattern.

Units are set via setMaximumRandomDeviationYUnit().

See also: maximumRandomDeviationY(); setMaximumRandomDeviationX()

Since: QGIS 3.24

Definition at line 2076 of file qgsfillsymbollayer.h.

◆ setOffsetX()

void QgsPointPatternFillSymbolLayer::setOffsetX ( double offset )

inline

Sets the horizontal offset values for points in the pattern.

Parameters

offset offset value

See also: offsetX(); setOffsetY()

Since: QGIS 3.8

Definition at line 1934 of file qgsfillsymbollayer.h.

◆ setOffsetXMapUnitScale()

void QgsPointPatternFillSymbolLayer::setOffsetXMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the unit scale for the horizontal offset for rows in the pattern.

Parameters

scale offset unit scale

See also: offsetXMapUnitScale(); setOffsetYMapUnitScale()

Since: QGIS 3.8

Definition at line 1985 of file qgsfillsymbollayer.h.

◆ setOffsetXUnit()

void QgsPointPatternFillSymbolLayer::setOffsetXUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the horizontal offset between rows in the pattern.

Parameters

unit	offset units

See also: offsetXUnit(); setOffsetYUnit()

Since: QGIS 3.8

Definition at line 1968 of file qgsfillsymbollayer.h.

◆ setOffsetY()

void QgsPointPatternFillSymbolLayer::setOffsetY ( double offset )

inline

Sets the vertical offset values for points in the pattern.

Parameters

offset offset value

See also: offsetY(); setOffsetX()

Since: QGIS 3.8

Definition at line 1951 of file qgsfillsymbollayer.h.

◆ setOffsetYMapUnitScale()

void QgsPointPatternFillSymbolLayer::setOffsetYMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the unit scale for the vertical offset for rows in the pattern.

Parameters

scale offset unit scale

See also: offsetYMapUnitScale(); setOffsetXMapUnitScale()

Since: QGIS 3.8

Definition at line 2019 of file qgsfillsymbollayer.h.

◆ setOffsetYUnit()

void QgsPointPatternFillSymbolLayer::setOffsetYUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the vertical offset for rows in the pattern.

Parameters

unit	offset units

See also: offsetYUnit(); setOffsetXUnit()

Since: QGIS 3.8

Definition at line 2002 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsPointPatternFillSymbolLayer::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

unit	output units

See also: outputUnit()

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3581 of file qgsfillsymbollayer.cpp.

◆ setRandomDeviationXMapUnitScale()

void QgsPointPatternFillSymbolLayer::setRandomDeviationXMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the unit scale for the horizontal random deviation of points in the pattern.

See also: randomDeviationXMapUnitScale(); setRandomDeviationYMapUnitScale()

Since: QGIS 3.24

Definition at line 2151 of file qgsfillsymbollayer.h.

◆ setRandomDeviationXUnit()

void QgsPointPatternFillSymbolLayer::setRandomDeviationXUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the horizontal random deviation of points in the pattern.

See also: randomDeviationXUnit(); setRandomDeviationYUnit()

Since: QGIS 3.24

Definition at line 2096 of file qgsfillsymbollayer.h.

◆ setRandomDeviationYMapUnitScale()

void QgsPointPatternFillSymbolLayer::setRandomDeviationYMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the unit scale for the vertical random deviation of points in the pattern.

See also: randomDeviationYMapUnitScale(); setRandomDeviationXMapUnitScale()

Since: QGIS 3.24

Definition at line 2160 of file qgsfillsymbollayer.h.

◆ setRandomDeviationYUnit()

void QgsPointPatternFillSymbolLayer::setRandomDeviationYUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the vertical random deviation of points in the pattern.

See also: randomDeviationYUnit(); setRandomDeviationXUnit()

Since: QGIS 3.24

Definition at line 2114 of file qgsfillsymbollayer.h.

◆ setSeed()

void QgsPointPatternFillSymbolLayer::setSeed ( unsigned long seed )

inline

Sets the random number seed to use when randomly shifting 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()

Since: QGIS 3.24

Definition at line 2178 of file qgsfillsymbollayer.h.

◆ setSubSymbol()

bool QgsPointPatternFillSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 4613 of file qgsfillsymbollayer.cpp.

◆ startFeatureRender()

void QgsPointPatternFillSymbolLayer::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 3942 of file qgsfillsymbollayer.cpp.

◆ startRender()

void QgsPointPatternFillSymbolLayer::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 3908 of file qgsfillsymbollayer.cpp.

◆ stopFeatureRender()

void QgsPointPatternFillSymbolLayer::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 3951 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsPointPatternFillSymbolLayer::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 3934 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsPointPatternFillSymbolLayer::subSymbol ( )

overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 4628 of file qgsfillsymbollayer.cpp.

◆ toSld()

void QgsPointPatternFillSymbolLayer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props
	)		const

overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 4343 of file qgsfillsymbollayer.cpp.

◆ toTiledPatternImage()

QImage QgsPointPatternFillSymbolLayer::toTiledPatternImage ( ) const

overridevirtual

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.

The default implementation returns a null image.

Returns: the tile image (not necessarily a square) or a null image if not implemented.

Since: QGIS 3.30

Reimplemented from QgsFillSymbolLayer.

Definition at line 4416 of file qgsfillsymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsPointPatternFillSymbolLayer::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 4687 of file qgsfillsymbollayer.cpp.

◆ usesMapUnits()

bool QgsPointPatternFillSymbolLayer::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 3623 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mDisplacementX

double QgsPointPatternFillSymbolLayer::mDisplacementX = 0

protected

Definition at line 2188 of file qgsfillsymbollayer.h.

◆ mDisplacementXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDisplacementXMapUnitScale

protected

Definition at line 2190 of file qgsfillsymbollayer.h.

◆ mDisplacementXUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mDisplacementXUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2189 of file qgsfillsymbollayer.h.

◆ mDisplacementY

double QgsPointPatternFillSymbolLayer::mDisplacementY = 0

protected

Definition at line 2191 of file qgsfillsymbollayer.h.

◆ mDisplacementYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDisplacementYMapUnitScale

protected

Definition at line 2193 of file qgsfillsymbollayer.h.

◆ mDisplacementYUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mDisplacementYUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2192 of file qgsfillsymbollayer.h.

◆ mDistanceX

double QgsPointPatternFillSymbolLayer::mDistanceX = 15

protected

Definition at line 2182 of file qgsfillsymbollayer.h.

◆ mDistanceXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDistanceXMapUnitScale

protected

Definition at line 2184 of file qgsfillsymbollayer.h.

◆ mDistanceXUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mDistanceXUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2183 of file qgsfillsymbollayer.h.

◆ mDistanceY

double QgsPointPatternFillSymbolLayer::mDistanceY = 15

protected

Definition at line 2185 of file qgsfillsymbollayer.h.

◆ mDistanceYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDistanceYMapUnitScale

protected

Definition at line 2187 of file qgsfillsymbollayer.h.

◆ mDistanceYUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mDistanceYUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2186 of file qgsfillsymbollayer.h.

◆ mMarkerSymbol

std::unique_ptr< QgsMarkerSymbol > QgsPointPatternFillSymbolLayer::mMarkerSymbol

protected

Definition at line 2181 of file qgsfillsymbollayer.h.

◆ mOffsetX

double QgsPointPatternFillSymbolLayer::mOffsetX = 0

protected

Definition at line 2194 of file qgsfillsymbollayer.h.

◆ mOffsetXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mOffsetXMapUnitScale

protected

Definition at line 2196 of file qgsfillsymbollayer.h.

◆ mOffsetXUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mOffsetXUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2195 of file qgsfillsymbollayer.h.

◆ mOffsetY

double QgsPointPatternFillSymbolLayer::mOffsetY = 0

protected

Definition at line 2197 of file qgsfillsymbollayer.h.

◆ mOffsetYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mOffsetYMapUnitScale

protected

Definition at line 2199 of file qgsfillsymbollayer.h.

◆ mOffsetYUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mOffsetYUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2198 of file qgsfillsymbollayer.h.

◆ mRandomDeviationX

double QgsPointPatternFillSymbolLayer::mRandomDeviationX = 0

protected

Definition at line 2201 of file qgsfillsymbollayer.h.

◆ mRandomDeviationXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mRandomDeviationXMapUnitScale

protected

Definition at line 2203 of file qgsfillsymbollayer.h.

◆ mRandomDeviationXUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mRandomDeviationXUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2202 of file qgsfillsymbollayer.h.

◆ mRandomDeviationY

double QgsPointPatternFillSymbolLayer::mRandomDeviationY = 0

protected

Definition at line 2204 of file qgsfillsymbollayer.h.

◆ mRandomDeviationYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mRandomDeviationYMapUnitScale

protected

Definition at line 2206 of file qgsfillsymbollayer.h.

◆ mRandomDeviationYUnit

Qgis::RenderUnit QgsPointPatternFillSymbolLayer::mRandomDeviationYUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 2205 of file qgsfillsymbollayer.h.

◆ mSeed

unsigned long QgsPointPatternFillSymbolLayer::mSeed = 0

protected

Definition at line 2207 of file qgsfillsymbollayer.h.

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

/build/qgis-3.32.0+99sid/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.32.0+99sid/src/core/symbology/qgsfillsymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsPointPatternFillSymbolLayer()

◆ ~QgsPointPatternFillSymbolLayer()

Member Function Documentation

◆ applyDataDefinedSettings()

◆ clipMode()

◆ clone()

◆ color()

◆ create()

◆ createFromSld()

◆ displacementX()

◆ displacementXMapUnitScale()

◆ displacementXUnit()

◆ displacementY()

◆ displacementYMapUnitScale()

◆ displacementYUnit()

◆ distanceX()

◆ distanceXMapUnitScale()

◆ distanceXUnit()

◆ distanceY()

◆ distanceYMapUnitScale()

◆ distanceYUnit()

◆ estimateMaxBleed()

◆ hasDataDefinedProperties()

◆ layerType()

◆ mapUnitScale()

◆ maximumRandomDeviationX()

◆ maximumRandomDeviationY()

◆ offsetX()

◆ offsetXMapUnitScale()

◆ offsetXUnit()

◆ offsetY()

◆ offsetYMapUnitScale()

◆ offsetYUnit()

◆ outputUnit()

◆ properties()

◆ randomDeviationXMapUnitScale()

◆ randomDeviationXUnit()

◆ randomDeviationYMapUnitScale()

◆ randomDeviationYUnit()

◆ renderPolygon()

◆ seed()

◆ setClipMode()

◆ setColor()

◆ setDisplacementX()

◆ setDisplacementXMapUnitScale()

◆ setDisplacementXUnit()

◆ setDisplacementY()

◆ setDisplacementYMapUnitScale()

◆ setDisplacementYUnit()

◆ setDistanceX()

◆ setDistanceXMapUnitScale()

◆ setDistanceXUnit()

◆ setDistanceY()

◆ setDistanceYMapUnitScale()

◆ setDistanceYUnit()

◆ setMapUnitScale()

◆ setMaximumRandomDeviationX()

◆ setMaximumRandomDeviationY()

◆ setOffsetX()

◆ setOffsetXMapUnitScale()

◆ setOffsetXUnit()

◆ setOffsetY()

◆ setOffsetYMapUnitScale()

◆ setOffsetYUnit()

◆ setOutputUnit()

◆ setRandomDeviationXMapUnitScale()

◆ setRandomDeviationXUnit()

◆ setRandomDeviationYMapUnitScale()

◆ setRandomDeviationYUnit()

◆ setSeed()

◆ setSubSymbol()

◆ startFeatureRender()

◆ startRender()