#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsPointPatternFillSymbolLayer:

Public Member Functions
	QgsPointPatternFillSymbolLayer ()

	~QgsPointPatternFillSymbolLayer () override

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

double	displacementX () const

const QgsMapUnitScale &	displacementXMapUnitScale () const

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

double	displacementY () const

const QgsMapUnitScale &	displacementYMapUnitScale () const

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

double	distanceX () const

const QgsMapUnitScale &	distanceXMapUnitScale () const

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

double	distanceY () const

const QgsMapUnitScale &	distanceYMapUnitScale () const

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

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

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

QgsUnitTypes::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer. More...

QgsStringMap	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	setColor (const QColor &c) override
	The fill color. More...

void	setDisplacementX (double d)

void	setDisplacementXMapUnitScale (const QgsMapUnitScale &scale)

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

void	setDisplacementY (double d)

void	setDisplacementYMapUnitScale (const QgsMapUnitScale &scale)

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

void	setDistanceX (double d)

void	setDistanceXMapUnitScale (const QgsMapUnitScale &scale)

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

void	setDistanceY (double d)

void	setDistanceYMapUnitScale (const QgsMapUnitScale &scale)

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

void	setMapUnitScale (const QgsMapUnitScale &scale) override

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 (QgsUnitTypes::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 (QgsUnitTypes::RenderUnit unit)
	Sets the units for the vertical offset for rows in the pattern. More...

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

bool	setSubSymbol (QgsSymbol *symbol) override
	Sets layer's subsymbol. takes ownership of the passed symbol. More...

void	startRender (QgsSymbolRenderContext &context) override
	Called before a set of rendering operations commences on the supplied render context. 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 QgsStringMap &props) const override

QSet< QString >	usedAttributes (const QgsRenderContext &context) const override
	Returns the set of attributes referenced by the layer. More...

Public Member Functions inherited from QgsImageFillSymbolLayer
	QgsImageFillSymbolLayer ()

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

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

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

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

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

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

QgsUnitTypes::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

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 QVector< qreal >	dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
	Gets dash pattern. More...

virtual double	dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets offset. More...

bool	enabled () const
	Returns `true` if symbol layer is enabled and will be drawn. More...

virtual QColor	fillColor () const
	Gets fill color. More...

virtual bool	isCompatibleWithSymbol (QgsSymbol *symbol) const
	Returns if the layer can be used below the specified symbol. More...

bool	isLocked () const

virtual QgsSymbolLayerReferenceList	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)

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 void	startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called before the layer will be rendered for a particular feature. More...

virtual void	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature. More...

virtual QColor	strokeColor () const
	Gets stroke color. More...

QgsSymbol::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 QgsStringMap &properties=QgsStringMap())
	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

Protected Member Functions inherited from QgsImageFillSymbolLayer
virtual bool	applyBrushTransformFromContext () const
	Returns `true` if the image brush should be transformed using the render context's texture origin. 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 (QgsSymbol::SymbolType type, bool locked=false)

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 QgsStringMap &stringMap)
	Restores older data defined properties from string map. More...

Protected Attributes
double	mDisplacementX = 0

QgsMapUnitScale	mDisplacementXMapUnitScale

QgsUnitTypes::RenderUnit	mDisplacementXUnit = QgsUnitTypes::RenderMillimeters

double	mDisplacementY = 0

QgsMapUnitScale	mDisplacementYMapUnitScale

QgsUnitTypes::RenderUnit	mDisplacementYUnit = QgsUnitTypes::RenderMillimeters

double	mDistanceX = 15

QgsMapUnitScale	mDistanceXMapUnitScale

QgsUnitTypes::RenderUnit	mDistanceXUnit = QgsUnitTypes::RenderMillimeters

double	mDistanceY = 15

QgsMapUnitScale	mDistanceYMapUnitScale

QgsUnitTypes::RenderUnit	mDistanceYUnit = QgsUnitTypes::RenderMillimeters

QgsMarkerSymbol *	mMarkerSymbol = nullptr

double	mOffsetX = 0

QgsMapUnitScale	mOffsetXMapUnitScale

QgsUnitTypes::RenderUnit	mOffsetXUnit = QgsUnitTypes::RenderMillimeters

double	mOffsetY = 0

QgsMapUnitScale	mOffsetYMapUnitScale

QgsUnitTypes::RenderUnit	mOffsetYUnit = QgsUnitTypes::RenderMillimeters

Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush	mBrush

double	mNextAngle = 0.0

std::unique_ptr< QgsLineSymbol >	mStroke
	Custom stroke. More...

double	mStrokeWidth = 0.0
	Stroke width. More...

QgsMapUnitScale	mStrokeWidthMapUnitScale

QgsUnitTypes::RenderUnit	mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters

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

QgsSymbol::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 }
	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

Definition at line 1539 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsPointPatternFillSymbolLayer()

QgsPointPatternFillSymbolLayer::QgsPointPatternFillSymbolLayer ( )

Definition at line 3081 of file qgsfillsymbollayer.cpp.

◆ ~QgsPointPatternFillSymbolLayer()

QgsPointPatternFillSymbolLayer::~QgsPointPatternFillSymbolLayer ( )

override

Definition at line 3094 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ applyDataDefinedSettings()

void QgsPointPatternFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext & context )

overrideprotectedvirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3613 of file qgsfillsymbollayer.cpp.

◆ clone()

QgsPointPatternFillSymbolLayer * QgsPointPatternFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 3540 of file qgsfillsymbollayer.cpp.

◆ color()

QColor QgsPointPatternFillSymbolLayer::color ( ) const

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 3693 of file qgsfillsymbollayer.cpp.

◆ create()

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

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

◆ createFromSld()

QgsSymbolLayer * QgsPointPatternFillSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 3591 of file qgsfillsymbollayer.cpp.

◆ displacementX()

double QgsPointPatternFillSymbolLayer::displacementX ( ) const

inline

Definition at line 1574 of file qgsfillsymbollayer.h.

◆ displacementXMapUnitScale()

const QgsMapUnitScale& QgsPointPatternFillSymbolLayer::displacementXMapUnitScale ( ) const

inline

Definition at line 1669 of file qgsfillsymbollayer.h.

◆ displacementXUnit()

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::displacementXUnit ( ) const

inline

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

See also: setDisplacementXUnit(); displacementYUnit()

Definition at line 1666 of file qgsfillsymbollayer.h.

◆ displacementY()

double QgsPointPatternFillSymbolLayer::displacementY ( ) const

inline

Definition at line 1577 of file qgsfillsymbollayer.h.

◆ displacementYMapUnitScale()

const QgsMapUnitScale& QgsPointPatternFillSymbolLayer::displacementYMapUnitScale ( ) const

inline

Definition at line 1687 of file qgsfillsymbollayer.h.

◆ displacementYUnit()

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::displacementYUnit ( ) const

inline

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

See also: setDisplacementYUnit(); displacementXUnit()

Definition at line 1684 of file qgsfillsymbollayer.h.

◆ distanceX()

double QgsPointPatternFillSymbolLayer::distanceX ( ) const

inline

Definition at line 1568 of file qgsfillsymbollayer.h.

◆ distanceXMapUnitScale()

const QgsMapUnitScale& QgsPointPatternFillSymbolLayer::distanceXMapUnitScale ( ) const

inline

Definition at line 1633 of file qgsfillsymbollayer.h.

◆ distanceXUnit()

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::distanceXUnit ( ) const

inline

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

See also: setDistanceXUnit(); distanceYUnit()

Definition at line 1630 of file qgsfillsymbollayer.h.

◆ distanceY()

double QgsPointPatternFillSymbolLayer::distanceY ( ) const

inline

Definition at line 1571 of file qgsfillsymbollayer.h.

◆ distanceYMapUnitScale()

const QgsMapUnitScale& QgsPointPatternFillSymbolLayer::distanceYMapUnitScale ( ) const

inline

Definition at line 1651 of file qgsfillsymbollayer.h.

◆ distanceYUnit()

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::distanceYUnit ( ) const

inline

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

See also: setDistanceYUnit(); distanceXUnit()

Definition at line 1648 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 QgsImageFillSymbolLayer.

Definition at line 3662 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 QgsImageFillSymbolLayer.

Definition at line 3677 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 3241 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3136 of file qgsfillsymbollayer.cpp.

◆ 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 1595 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 1721 of file qgsfillsymbollayer.h.

◆ offsetXUnit()

QgsUnitTypes::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 1704 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 1612 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 1755 of file qgsfillsymbollayer.h.

◆ offsetYUnit()

QgsUnitTypes::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 1738 of file qgsfillsymbollayer.h.

◆ outputUnit()

QgsUnitTypes::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 3115 of file qgsfillsymbollayer.cpp.

◆ properties()

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

Implements QgsSymbolLayer.

Definition at line 3514 of file qgsfillsymbollayer.cpp.

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

◆ setColor()

void QgsPointPatternFillSymbolLayer::setColor ( const QColor & color )

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 3686 of file qgsfillsymbollayer.cpp.

◆ setDisplacementX()

void QgsPointPatternFillSymbolLayer::setDisplacementX ( double d )

inline

Definition at line 1575 of file qgsfillsymbollayer.h.

◆ setDisplacementXMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDisplacementXMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 1668 of file qgsfillsymbollayer.h.

◆ setDisplacementXUnit()

void QgsPointPatternFillSymbolLayer::setDisplacementXUnit ( QgsUnitTypes::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 1659 of file qgsfillsymbollayer.h.

◆ setDisplacementY()

void QgsPointPatternFillSymbolLayer::setDisplacementY ( double d )

inline

Definition at line 1578 of file qgsfillsymbollayer.h.

◆ setDisplacementYMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDisplacementYMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 1686 of file qgsfillsymbollayer.h.

◆ setDisplacementYUnit()

void QgsPointPatternFillSymbolLayer::setDisplacementYUnit ( QgsUnitTypes::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 1677 of file qgsfillsymbollayer.h.

◆ setDistanceX()

void QgsPointPatternFillSymbolLayer::setDistanceX ( double d )

inline

Definition at line 1569 of file qgsfillsymbollayer.h.

◆ setDistanceXMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDistanceXMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 1632 of file qgsfillsymbollayer.h.

◆ setDistanceXUnit()

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

inline

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

Parameters

unit	distance units

See also: distanceXUnit(); setDistanceYUnit()

Definition at line 1623 of file qgsfillsymbollayer.h.

◆ setDistanceY()

void QgsPointPatternFillSymbolLayer::setDistanceY ( double d )

inline

Definition at line 1572 of file qgsfillsymbollayer.h.

◆ setDistanceYMapUnitScale()

void QgsPointPatternFillSymbolLayer::setDistanceYMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 1650 of file qgsfillsymbollayer.h.

◆ setDistanceYUnit()

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

inline

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

Parameters

unit	distance units

See also: distanceYUnit(); setDistanceXUnit()

Definition at line 1641 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsPointPatternFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3125 of file qgsfillsymbollayer.cpp.

◆ 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 1587 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 1713 of file qgsfillsymbollayer.h.

◆ setOffsetXUnit()

void QgsPointPatternFillSymbolLayer::setOffsetXUnit ( QgsUnitTypes::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 1696 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 1604 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 1747 of file qgsfillsymbollayer.h.

◆ setOffsetYUnit()

void QgsPointPatternFillSymbolLayer::setOffsetYUnit ( QgsUnitTypes::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 1730 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsPointPatternFillSymbolLayer::setOutputUnit ( QgsUnitTypes::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 3099 of file qgsfillsymbollayer.cpp.

◆ setSubSymbol()

bool QgsPointPatternFillSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 3597 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 3338 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 3360 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol* QgsPointPatternFillSymbolLayer::subSymbol ( )

inlineoverridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1615 of file qgsfillsymbollayer.h.

◆ toSld()

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

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 3552 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 QgsImageFillSymbolLayer.

Definition at line 3667 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mDisplacementX

double QgsPointPatternFillSymbolLayer::mDisplacementX = 0

protected

Definition at line 1776 of file qgsfillsymbollayer.h.

◆ mDisplacementXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDisplacementXMapUnitScale

protected

Definition at line 1778 of file qgsfillsymbollayer.h.

◆ mDisplacementXUnit

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::mDisplacementXUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 1777 of file qgsfillsymbollayer.h.

◆ mDisplacementY

double QgsPointPatternFillSymbolLayer::mDisplacementY = 0

protected

Definition at line 1779 of file qgsfillsymbollayer.h.

◆ mDisplacementYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDisplacementYMapUnitScale

protected

Definition at line 1781 of file qgsfillsymbollayer.h.

◆ mDisplacementYUnit

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::mDisplacementYUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 1780 of file qgsfillsymbollayer.h.

◆ mDistanceX

double QgsPointPatternFillSymbolLayer::mDistanceX = 15

protected

Definition at line 1770 of file qgsfillsymbollayer.h.

◆ mDistanceXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDistanceXMapUnitScale

protected

Definition at line 1772 of file qgsfillsymbollayer.h.

◆ mDistanceXUnit

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::mDistanceXUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 1771 of file qgsfillsymbollayer.h.

◆ mDistanceY

double QgsPointPatternFillSymbolLayer::mDistanceY = 15

protected

Definition at line 1773 of file qgsfillsymbollayer.h.

◆ mDistanceYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mDistanceYMapUnitScale

protected

Definition at line 1775 of file qgsfillsymbollayer.h.

◆ mDistanceYUnit

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::mDistanceYUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 1774 of file qgsfillsymbollayer.h.

◆ mMarkerSymbol

QgsMarkerSymbol* QgsPointPatternFillSymbolLayer::mMarkerSymbol = nullptr

protected

Definition at line 1769 of file qgsfillsymbollayer.h.

◆ mOffsetX

double QgsPointPatternFillSymbolLayer::mOffsetX = 0

protected

Definition at line 1782 of file qgsfillsymbollayer.h.

◆ mOffsetXMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mOffsetXMapUnitScale

protected

Definition at line 1784 of file qgsfillsymbollayer.h.

◆ mOffsetXUnit

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::mOffsetXUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 1783 of file qgsfillsymbollayer.h.

◆ mOffsetY

double QgsPointPatternFillSymbolLayer::mOffsetY = 0

protected

Definition at line 1785 of file qgsfillsymbollayer.h.

◆ mOffsetYMapUnitScale

QgsMapUnitScale QgsPointPatternFillSymbolLayer::mOffsetYMapUnitScale

protected

Definition at line 1787 of file qgsfillsymbollayer.h.

◆ mOffsetYUnit

QgsUnitTypes::RenderUnit QgsPointPatternFillSymbolLayer::mOffsetYUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 1786 of file qgsfillsymbollayer.h.

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

/build/qgis-3.16.0+99unstable/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.16.0+99unstable/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()

◆ clone()

◆ color()

◆ create()

◆ createFromSld()

◆ displacementX()

◆ displacementXMapUnitScale()

◆ displacementXUnit()

◆ displacementY()

◆ displacementYMapUnitScale()

◆ displacementYUnit()

◆ distanceX()

◆ distanceXMapUnitScale()

◆ distanceXUnit()

◆ distanceY()

◆ distanceYMapUnitScale()

◆ distanceYUnit()

◆ estimateMaxBleed()

◆ hasDataDefinedProperties()

◆ layerType()

◆ mapUnitScale()

◆ offsetX()

◆ offsetXMapUnitScale()

◆ offsetXUnit()

◆ offsetY()

◆ offsetYMapUnitScale()

◆ offsetYUnit()

◆ outputUnit()

◆ properties()

◆ renderPolygon()

◆ setColor()

◆ setDisplacementX()

◆ setDisplacementXMapUnitScale()

◆ setDisplacementXUnit()

◆ setDisplacementY()

◆ setDisplacementYMapUnitScale()

◆ setDisplacementYUnit()

◆ setDistanceX()

◆ setDistanceXMapUnitScale()

◆ setDistanceXUnit()

◆ setDistanceY()

◆ setDistanceYMapUnitScale()

◆ setDistanceYUnit()

◆ setMapUnitScale()

◆ setOffsetX()

◆ setOffsetXMapUnitScale()

◆ setOffsetXUnit()

◆ setOffsetY()

◆ setOffsetYMapUnitScale()

◆ setOffsetYUnit()

◆ setOutputUnit()

◆ setSubSymbol()

◆ startRender()

◆ stopRender()

◆ subSymbol()

◆ toSld()

◆ usedAttributes()

Member Data Documentation

◆ mDisplacementX

◆ mDisplacementXMapUnitScale

◆ mDisplacementXUnit

◆ mDisplacementY

◆ mDisplacementYMapUnitScale

◆ mDisplacementYUnit

◆ mDistanceX

◆ mDistanceXMapUnitScale

◆ mDistanceXUnit

◆ mDistanceY

◆ mDistanceYMapUnitScale

◆ mDistanceYUnit