#include <qgsgeometrygeneratorsymbollayer.h>

Inheritance diagram for QgsGeometryGeneratorSymbolLayer:

Public Member Functions
	~QgsGeometryGeneratorSymbolLayer () override

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

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

QString	geometryExpression () const
	Gets the expression to generate this geometry. More...

bool	hasDataDefinedProperties () const override
	Returns `true` if the symbol layer (or any of its sub-symbols) contains data defined properties. More...

bool	isCompatibleWithSymbol (QgsSymbol *symbol) const override
	Will always return `true`. More...

QString	layerType () const override
	Returns a string that represents this layer type. 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...

virtual void	render (QgsSymbolRenderContext &context)
	Will render this symbol layer using the context. More...

void	setColor (const QColor &color) override
	The fill color. More...

void	setGeometryExpression (const QString &exp)
	Set the expression to generate this geometry. More...

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

void	setSymbolType (Qgis::SymbolType symbolType)
	Set the type of symbol which should be created. 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...

Qgis::SymbolType	symbolType () const
	Access the symbol type. 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 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 QColor	color () const
	The fill color. 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 double	dxfAngle (QgsSymbolRenderContext &context) const
	Gets angle. More...

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

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

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

virtual QVector< qreal >	dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
	Gets dash pattern. More...

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

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

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

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

virtual double	estimateMaxBleed (const QgsRenderContext &context) const
	Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More...

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

bool	isLocked () const
	Returns `true` if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More...

virtual QgsMapUnitScale	mapUnitScale () const

virtual QList< QgsSymbolLayerReference >	masks () const
	Returns masks defined by this symbol layer. More...

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete
	QgsSymbolLayer cannot be copied. More...

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

QgsPaintEffect *	paintEffect () const
	Returns the current paint effect for the layer. More...

virtual void	prepareExpressions (const QgsSymbolRenderContext &context)
	Prepares all data defined property expressions for evaluation. More...

int	renderingPass () const
	Specifies the rendering pass in which this symbol layer should be rendered. More...

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the symbol layer's property collection, used for data defined overrides. More...

virtual void	setDataDefinedProperty (Property key, const QgsProperty &property)
	Sets a data defined property for the layer. More...

void	setEnabled (bool enabled)
	Sets whether symbol layer is enabled and should be drawn. More...

virtual void	setFillColor (const QColor &color)
	Set fill color. More...

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

virtual void	setMapUnitScale (const QgsMapUnitScale &scale)

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

void	setPaintEffect (QgsPaintEffect *effect)
	Sets the current paint effect for the layer. More...

void	setRenderingPass (int renderingPass)
	Specifies the rendering pass in which this symbol layer should be rendered. More...

virtual void	setStrokeColor (const QColor &color)
	Set stroke color. More...

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

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

Qgis::SymbolType	type () const

virtual bool	writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
	write as DXF More...

Static Public Member Functions
static QgsSymbolLayer *	create (const QVariantMap &properties)
	Creates the symbol layer. More...

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

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 }
	Data definable properties. More...

Protected Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (Qgis::SymbolType type, bool locked=false)
	Constructor for QgsSymbolLayer. More...

void	copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
	Copies all data defined properties of this layer to another symbol layer. More...

void	copyPaintEffect (QgsSymbolLayer *destLayer) const
	Copies paint effect of this layer to another symbol layer. More...

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

Protected Attributes inherited from QgsSymbolLayer
QColor	mColor

QgsPropertyCollection	mDataDefinedProperties

bool	mEnabled = true
	True if layer is enabled and should be drawn. More...

QgsFields	mFields

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

Static Protected Attributes inherited from QgsSymbolLayer
static const bool	SELECT_FILL_BORDER = false
	Whether fill styles for selected features also highlight symbol stroke. More...

static const bool	SELECT_FILL_STYLE = false
	Whether fill styles for selected features uses symbol layer style. More...

static const bool	SELECTION_IS_OPAQUE = true
	Whether styles for selected features ignore symbol alpha. More...

Detailed Description

Definition at line 31 of file qgsgeometrygeneratorsymbollayer.h.

Constructor & Destructor Documentation

◆ ~QgsGeometryGeneratorSymbolLayer()

QgsGeometryGeneratorSymbolLayer::~QgsGeometryGeneratorSymbolLayer ( )

overridedefault

Member Function Documentation

◆ clone()

QgsSymbolLayer * QgsGeometryGeneratorSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 124 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsGeometryGeneratorSymbolLayer::create ( const QVariantMap & properties )

static

Creates the symbol layer.

Definition at line 24 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ drawPreviewIcon()

void QgsGeometryGeneratorSymbolLayer::drawPreviewIcon	(	QgsSymbolRenderContext &	context,
		QSize	size
	)

overridevirtual

Implements QgsSymbolLayer.

Definition at line 162 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ geometryExpression()

QString QgsGeometryGeneratorSymbolLayer::geometryExpression ( ) const

inline

Gets the expression to generate this geometry.

Definition at line 77 of file qgsgeometrygeneratorsymbollayer.h.

◆ hasDataDefinedProperties()

bool QgsGeometryGeneratorSymbolLayer::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 205 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ isCompatibleWithSymbol()

bool QgsGeometryGeneratorSymbolLayer::isCompatibleWithSymbol ( QgsSymbol * symbol ) const

overridevirtual

Will always return true.

This is a hybrid layer, it constructs its own geometry so it does not care about the geometry of its parents.

Reimplemented from QgsSymbolLayer.

Definition at line 213 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ layerType()

QString QgsGeometryGeneratorSymbolLayer::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 58 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ properties()

QVariantMap QgsGeometryGeneratorSymbolLayer::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 143 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ render()

void QgsGeometryGeneratorSymbolLayer::render ( QgsSymbolRenderContext & context )

virtual

Will render this symbol layer using the context.

In comparison to other symbols there is no geometry passed in, since the geometry will be created based on information from the context which contains a QgsRenderContext which in turn contains an expression context which is available to the evaluated expression.

Parameters

context The rendering context which will be used to render and to construct a geometry.

Definition at line 218 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setColor()

void QgsGeometryGeneratorSymbolLayer::setColor ( const QColor & color )

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 242 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setGeometryExpression()

void QgsGeometryGeneratorSymbolLayer::setGeometryExpression ( const QString & exp )

Set the expression to generate this geometry.

Definition at line 168 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setSubSymbol()

bool QgsGeometryGeneratorSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 173 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ setSymbolType()

void QgsGeometryGeneratorSymbolLayer::setSymbolType ( Qgis::SymbolType symbolType )

Set the type of symbol which should be created.

Should match with the return type of the expression.

Parameters

symbolType The symbol type which shall be used below this symbol.

Definition at line 63 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ startFeatureRender()

void QgsGeometryGeneratorSymbolLayer::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 102 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ startRender()

void QgsGeometryGeneratorSymbolLayer::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 89 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ stopFeatureRender()

void QgsGeometryGeneratorSymbolLayer::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 108 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ stopRender()

void QgsGeometryGeneratorSymbolLayer::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 96 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ subSymbol()

QgsSymbol* QgsGeometryGeneratorSymbolLayer::subSymbol ( )

inlineoverridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 79 of file qgsgeometrygeneratorsymbollayer.h.

◆ symbolType()

Qgis::SymbolType QgsGeometryGeneratorSymbolLayer::symbolType ( ) const

inline

Access the symbol type.

This defines the type of geometry that is created by this generator.

Returns: Symbol type

Definition at line 55 of file qgsgeometrygeneratorsymbollayer.h.

◆ usedAttributes()

QSet< QString > QgsGeometryGeneratorSymbolLayer::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 198 of file qgsgeometrygeneratorsymbollayer.cpp.

◆ usesMapUnits()

bool QgsGeometryGeneratorSymbolLayer::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 113 of file qgsgeometrygeneratorsymbollayer.cpp.

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

/build/qgis-3.20.0+99unstable/src/core/symbology/qgsgeometrygeneratorsymbollayer.h
/build/qgis-3.20.0+99unstable/src/core/symbology/qgsgeometrygeneratorsymbollayer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~QgsGeometryGeneratorSymbolLayer()

Member Function Documentation

◆ clone()

◆ create()

◆ drawPreviewIcon()

◆ geometryExpression()

◆ hasDataDefinedProperties()

◆ isCompatibleWithSymbol()

◆ layerType()

◆ properties()

◆ render()

◆ setColor()

◆ setGeometryExpression()

◆ setSubSymbol()

◆ setSymbolType()

◆ startFeatureRender()

◆ startRender()

◆ stopFeatureRender()

◆ stopRender()

◆ subSymbol()

◆ symbolType()

◆ usedAttributes()

◆ usesMapUnits()