#include <qgssymbollayer.h>

Inheritance diagram for QgsSymbolLayer:

[legend]

Public Types
enum class	Property : int { Size = 0 , Angle , Name , FillColor , StrokeColor , StrokeWidth , StrokeStyle , Offset , Character , Width , Height , PreserveAspectRatio , FillStyle , JoinStyle , SecondaryColor , LineAngle , LineDistance , GradientType , CoordinateMode , GradientSpread , GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y , GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape , ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX , DistanceY , DisplacementX , DisplacementY , Opacity , CustomDash , CapStyle , Placement , Interval , OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor , LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength , ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX , OffsetY , PointCount , RandomSeed , ClipPoints , DensityArea , FontFamily , FontStyle , DashPatternOffset , TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue , LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX , RandomOffsetY , LineClipping , SkipMultiples , ShowMarker }
	Data definable properties. More...

Public Member Functions
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete

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.

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

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

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

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

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

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

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

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

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

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

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

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

virtual double	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets marker size.

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

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

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

virtual QColor	fillColor () const
	Returns the fill color for the symbol layer.

virtual Qgis::SymbolLayerFlags	flags () const
	Returns flags which control the symbol layer's behavior.

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

QString	id () const
	Returns symbol layer identifier This id is unique in the whole project.

bool	installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF())
	When rendering, install masks on context painter.

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

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

virtual QString	layerType () const =0
	Returns a string that represents this layer type.

virtual QgsMapUnitScale	mapUnitScale () const

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

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete

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

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

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

virtual void	prepareMasks (const QgsSymbolRenderContext &context)
	Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method.

virtual QVariantMap	properties () const =0
	Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

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

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

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

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

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

virtual void	setFillColor (const QColor &color)
	Sets the fill color for the symbol layer.

void	setId (const QString &id)
	Set symbol layer identifier This id has to be unique in the whole project.

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

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.

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

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

virtual void	setStrokeColor (const QColor &color)
	Sets the stroke color for the symbol layer.

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

void	setUserFlags (Qgis::SymbolLayerUserFlags flags)
	Sets user-controlled flags which control the symbol layer's behavior.

virtual void	startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called before the layer will be rendered for a particular feature.

virtual void	startRender (QgsSymbolRenderContext &context)=0
	Called before a set of rendering operations commences on the supplied render context.

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

virtual void	stopRender (QgsSymbolRenderContext &context)=0
	Called after a set of rendering operations has finished on the supplied render context.

virtual QColor	strokeColor () const
	Returns the stroke color for the symbol layer.

virtual QgsSymbol *	subSymbol ()
	Returns the symbol's sub symbol, if present.

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

Qgis::SymbolType	type () const

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

Qgis::SymbolLayerUserFlags	userFlags () const
	Returns user-controlled flags which control the symbol layer's behavior.

virtual bool	usesMapUnits () const
	Returns `true` if the symbol layer has any components which use map unit based sizes.

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

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

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

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

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

void	removeMasks (QgsRenderContext &context, bool recursive)
	When rendering, remove previously installed masks from context painter if recursive is `true` masks are removed recursively for all children symbol layers.

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

bool	shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
	Returns `true` if the symbol layer should be rendered using the selection color from the render context.

Protected Attributes
QPainterPath	mClipPath

QColor	mColor

QgsPropertyCollection	mDataDefinedProperties

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

QgsFields	mFields

QString	mId

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

Qgis::SymbolLayerUserFlags	mUserFlags
	User controlled flags.

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

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

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

Detailed Description

Definition at line 54 of file qgssymbollayer.h.

Member Enumeration Documentation

◆ Property

enum class QgsSymbolLayer::Property : int

strong

Data definable properties.

Enumerator
Size	Symbol size.
Angle	Symbol angle.
Name	Name, eg shape name for simple markers.
FillColor	Fill color.
StrokeColor	Stroke color.
StrokeWidth	Stroke width.
StrokeStyle	Stroke style (eg solid, dashed)
Offset	Symbol offset.
Character	Character, eg for font marker symbol layers.
Width	Symbol width.
Height	Symbol height.
PreserveAspectRatio	Preserve aspect ratio between width and height.
FillStyle	Fill style (eg solid, dots)
JoinStyle	Line join style.
SecondaryColor	Secondary color (eg for gradient fills)
LineAngle	Line angle, or angle of hash lines for hash line symbols.
LineDistance	Distance between lines, or length of lines for hash line symbols.
GradientType	Gradient fill type.
CoordinateMode	Gradient coordinate mode.
GradientSpread	Gradient spread mode.
GradientReference1X	Gradient reference point 1 x.
GradientReference1Y	Gradient reference point 1 y.
GradientReference2X	Gradient reference point 2 x.
GradientReference2Y	Gradient reference point 2 y.
GradientReference1IsCentroid	Gradient reference point 1 is centroid.
GradientReference2IsCentroid	Gradient reference point 2 is centroid.
BlurRadius	Shapeburst blur radius.
ShapeburstUseWholeShape	Shapeburst use whole shape.
ShapeburstMaxDistance	Shapeburst fill from edge distance.
ShapeburstIgnoreRings	Shapeburst ignore rings.
File	Filename, eg for svg files.
DistanceX	Horizontal distance between points.
DistanceY	Vertical distance between points.
DisplacementX	Horizontal displacement.
DisplacementY	Vertical displacement.
Opacity	Opacity.
CustomDash	Custom dash pattern.
CapStyle	Line cap style.
Placement	Line marker placement.
Interval	Line marker interval.
OffsetAlongLine	Offset along line.
AverageAngleLength	Length to average symbol angles over.
HorizontalAnchor	Horizontal anchor point.
VerticalAnchor	Vertical anchor point.
LayerEnabled	Whether symbol layer is enabled.
ArrowWidth	Arrow tail width.
ArrowStartWidth	Arrow tail start width.
ArrowHeadLength	Arrow head length.
ArrowHeadThickness	Arrow head thickness.
ArrowHeadType	Arrow head type.
ArrowType	Arrow type.
OffsetX	Horizontal offset.
OffsetY	Vertical offset.
PointCount	Point count.
RandomSeed	Random number seed.
ClipPoints	Whether markers should be clipped to polygon boundaries.
DensityArea	Density area.
FontFamily	Font family.
FontStyle	Font style.
DashPatternOffset	Dash pattern offset,.
TrimStart	Trim distance from start of line. Since QGIS 3.20
TrimEnd	Trim distance from end of line. Since QGIS 3.20
LineStartWidthValue	Start line width for interpolated line renderer. Since QGIS 3.22
LineEndWidthValue	End line width for interpolated line renderer. Since QGIS 3.22
LineStartColorValue	Start line color for interpolated line renderer. Since QGIS 3.22
LineEndColorValue	End line color for interpolated line renderer. Since QGIS 3.22
MarkerClipping	Marker clipping mode. Since QGIS 3.24
RandomOffsetX	Random offset X. Since QGIS 3.24
RandomOffsetY	Random offset Y. Since QGIS 3.24
LineClipping	Line clipping mode. Since QGIS 3.24
SkipMultiples	Skip multiples of. Since QGIS 3.40
ShowMarker	Show markers. Since QGIS 3.40

Definition at line 147 of file qgssymbollayer.h.

Constructor & Destructor Documentation

◆ ~QgsSymbolLayer()

QgsSymbolLayer::~QgsSymbolLayer ( )

virtualdefault

◆ QgsSymbolLayer() [1/2]

QgsSymbolLayer::QgsSymbolLayer ( const QgsSymbolLayer & other )

delete

◆ QgsSymbolLayer() [2/2]

QgsSymbolLayer::QgsSymbolLayer	(	Qgis::SymbolType	type,
		bool	locked = `false`
	)

protected

Constructor for QgsSymbolLayer.

Parameters

type	specifies the associated symbol type
locked	if `true`, then symbol layer colors will be locked and will ignore any symbol-level color changes.

Definition at line 234 of file qgssymbollayer.cpp.

Member Function Documentation

◆ canCauseArtifactsBetweenAdjacentTiles()

bool QgsSymbolLayer::canCauseArtifactsBetweenAdjacentTiles ( ) const

virtual

Returns true if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry.

The default implementation returns false.

Since: QGIS 3.18

Reimplemented in QgsArrowSymbolLayer, QgsGradientFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsInterpolatedLineSymbolLayer, QgsSimpleLineSymbolLayer, and QgsTemplatedLineSymbolLayerBase.

Definition at line 317 of file qgssymbollayer.cpp.

◆ clone()

virtual QgsSymbolLayer * QgsSymbolLayer::clone ( ) const

pure virtual

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

◆ color()

QColor QgsSymbolLayer::color ( ) const

virtual

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 in QgsArrowSymbolLayer, QgsRasterFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsInterpolatedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsRasterLineSymbolLayer, QgsFilledLineSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsFilledMarkerSymbolLayer, QgsRasterMarkerSymbolLayer, QgsMaskMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 256 of file qgssymbollayer.cpp.

◆ copyDataDefinedProperties()

void QgsSymbolLayer::copyDataDefinedProperties ( QgsSymbolLayer * destLayer ) const

protected

Copies all data defined properties of this layer to another symbol layer.

Parameters

destLayer destination layer

Definition at line 492 of file qgssymbollayer.cpp.

◆ copyPaintEffect()

void QgsSymbolLayer::copyPaintEffect ( QgsSymbolLayer * destLayer ) const

protected

Copies paint effect of this layer to another symbol layer.

Parameters

destLayer destination layer

Definition at line 500 of file qgssymbollayer.cpp.

◆ dataDefinedProperties() [1/2]

QgsPropertyCollection & QgsSymbolLayer::dataDefinedProperties ( )

inline

Returns a reference to the symbol layer's property collection, used for data defined overrides.

See also: setDataDefinedProperties(); Property

Definition at line 607 of file qgssymbollayer.h.

◆ dataDefinedProperties() [2/2]

const QgsPropertyCollection & QgsSymbolLayer::dataDefinedProperties ( ) const

inline

Returns a reference to the symbol layer's property collection, used for data defined overrides.

See also: setDataDefinedProperties()

Definition at line 613 of file qgssymbollayer.h.

◆ drawPreviewIcon()

virtual void QgsSymbolLayer::drawPreviewIcon	(	QgsSymbolRenderContext &	context,
		QSize	size
	)

pure virtual

Implemented in QgsGeometryGeneratorSymbolLayer, QgsInterpolatedLineSymbolLayer, QgsMaskMarkerSymbolLayer, QgsMarkerSymbolLayer, QgsLineSymbolLayer, QgsFillSymbolLayer, and QgsVectorFieldSymbolLayer.

◆ dxfAngle()

double QgsSymbolLayer::dxfAngle ( QgsSymbolRenderContext & context ) const

virtual

Gets angle.

Reimplemented in QgsSimpleFillSymbolLayer, and QgsMarkerSymbolLayer.

Definition at line 193 of file qgssymbollayer.cpp.

◆ dxfBrushColor()

QColor QgsSymbolLayer::dxfBrushColor ( QgsSymbolRenderContext & context ) const

virtual

Gets brush/fill color.

Reimplemented in QgsSimpleFillSymbolLayer.

Definition at line 210 of file qgssymbollayer.cpp.

◆ dxfBrushStyle()

Qt::BrushStyle QgsSymbolLayer::dxfBrushStyle ( ) const

virtual

Gets brush/fill style.

Reimplemented in QgsSimpleFillSymbolLayer.

Definition at line 216 of file qgssymbollayer.cpp.

◆ dxfColor()

QColor QgsSymbolLayer::dxfColor ( QgsSymbolRenderContext & context ) const

virtual

Gets color.

Reimplemented in QgsSimpleFillSymbolLayer, QgsSVGFillSymbolLayer, and QgsSimpleLineSymbolLayer.

Definition at line 187 of file qgssymbollayer.cpp.

◆ dxfCustomDashPattern()

QVector< qreal > QgsSymbolLayer::dxfCustomDashPattern ( Qgis::RenderUnit & unit ) const

virtual

Gets dash pattern.

Reimplemented in QgsSimpleLineSymbolLayer.

Definition at line 199 of file qgssymbollayer.cpp.

◆ dxfOffset()

double QgsSymbolLayer::dxfOffset	(	const QgsDxfExport &	e,
		QgsSymbolRenderContext &	context
	)		const

virtual

Gets offset.

Reimplemented in QgsSimpleLineSymbolLayer.

Definition at line 180 of file qgssymbollayer.cpp.

◆ dxfPenStyle()

Qt::PenStyle QgsSymbolLayer::dxfPenStyle ( ) const

virtual

Gets pen style.

Reimplemented in QgsSimpleFillSymbolLayer, QgsImageFillSymbolLayer, and QgsSimpleLineSymbolLayer.

Definition at line 205 of file qgssymbollayer.cpp.

◆ dxfSize()

double QgsSymbolLayer::dxfSize	(	const QgsDxfExport &	e,
		QgsSymbolRenderContext &	context
	)		const

virtual

Gets marker size.

Reimplemented in QgsMarkerSymbolLayer.

Definition at line 173 of file qgssymbollayer.cpp.

◆ dxfWidth()

double QgsSymbolLayer::dxfWidth	(	const QgsDxfExport &	e,
		QgsSymbolRenderContext &	context
	)		const

virtual

Gets line width.

Reimplemented in QgsSimpleFillSymbolLayer, QgsImageFillSymbolLayer, QgsSimpleLineSymbolLayer, and QgsLineSymbolLayer.

Definition at line 166 of file qgssymbollayer.cpp.

◆ enabled()

bool QgsSymbolLayer::enabled ( ) const

inline

Returns true if symbol layer is enabled and will be drawn.

See also: setEnabled()

Definition at line 245 of file qgssymbollayer.h.

◆ estimateMaxBleed()

virtual double QgsSymbolLayer::estimateMaxBleed ( const QgsRenderContext & context ) const

inlinevirtual

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 in QgsSimpleFillSymbolLayer, QgsGradientFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsSimpleLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsRasterLineSymbolLayer, QgsLineburstSymbolLayer, QgsFilledLineSymbolLayer, and QgsFilledMarkerSymbolLayer.

Definition at line 489 of file qgssymbollayer.h.

◆ fillColor()

QColor QgsSymbolLayer::fillColor ( ) const

virtual

Returns the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component. Symbol layers without a fill component will return an invalid QColor.

See also: setFillColor(); color(); strokeColor()

Reimplemented in QgsEllipseSymbolLayer, QgsSimpleFillSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsSvgMarkerSymbolLayer.

Definition at line 280 of file qgssymbollayer.cpp.

◆ flags()

Qgis::SymbolLayerFlags QgsSymbolLayer::flags ( ) const

virtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented in QgsEllipseSymbolLayer, QgsSimpleFillSymbolLayer, QgsGradientFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsRasterFillSymbolLayer, QgsInterpolatedLineSymbolLayer, QgsLinearReferencingSymbolLayer, QgsSimpleLineSymbolLayer, QgsRasterLineSymbolLayer, QgsLineburstSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsRasterMarkerSymbolLayer, and QgsFontMarkerSymbolLayer.

Definition at line 241 of file qgssymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsSymbolLayer::hasDataDefinedProperties ( ) const

virtual

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

Since: QGIS 3.4.5

Reimplemented in QgsArrowSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsFilledLineSymbolLayer, QgsFilledMarkerSymbolLayer, QgsMaskMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 296 of file qgssymbollayer.cpp.

◆ id()

QString QgsSymbolLayer::id ( ) const

Returns symbol layer identifier This id is unique in the whole project.

Since: QGIS 3.30

Definition at line 1067 of file qgssymbollayer.cpp.

◆ installMasks()

bool QgsSymbolLayer::installMasks	(	QgsRenderContext &	context,
		bool	recursive,
		const QRectF &	rect = `QRectF()`
	)

When rendering, install masks on context painter.

If recursive is true masks are installed recursively for all children symbol layers.

Since QGIS 3.38 the rect argument can be used to specify a target bounds (in painter coordinates) for mask geometries. Only mask geometries which intersect rect will be installed.

Returns: true if any masks were installed (since QGIS 3.38)

See also: prepareMasks(); removeMasks()

Since: QGIS 3.30

Definition at line 1011 of file qgssymbollayer.cpp.

◆ isCompatibleWithSymbol()

bool QgsSymbolLayer::isCompatibleWithSymbol ( QgsSymbol * symbol ) const

virtual

Returns if the layer can be used below the specified symbol.

Reimplemented in QgsGeometryGeneratorSymbolLayer.

Definition at line 309 of file qgssymbollayer.cpp.

◆ isLocked()

bool QgsSymbolLayer::isLocked ( ) const

inline

Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

See also: setLocked()

Definition at line 480 of file qgssymbollayer.h.

◆ layerType()

virtual QString QgsSymbolLayer::layerType ( ) const

pure virtual

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.

◆ mapUnitScale()

virtual QgsMapUnitScale QgsSymbolLayer::mapUnitScale ( ) const

inlinevirtual

◆ masks()

QList< QgsSymbolLayerReference > QgsSymbolLayer::masks ( ) const

virtual

Returns masks defined by this symbol layer.

This is a list of symbol layers of other layers that should be occluded.

Since: QGIS 3.12

Reimplemented in QgsMaskMarkerSymbolLayer.

Definition at line 919 of file qgssymbollayer.cpp.

◆ ogrFeatureStyle()

virtual QString QgsSymbolLayer::ogrFeatureStyle	(	double	mmScaleFactor,
		double	mapUnitScaleFactor
	)		const

inlinevirtual

Reimplemented in QgsSimpleFillSymbolLayer, QgsSimpleLineSymbolLayer, and QgsSimpleMarkerSymbolLayer.

Definition at line 432 of file qgssymbollayer.h.

◆ operator=()

QgsSymbolLayer & QgsSymbolLayer::operator= ( const QgsSymbolLayer & other )

delete

◆ outputUnit()

virtual Qgis::RenderUnit QgsSymbolLayer::outputUnit ( ) const

inlinevirtual

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

Definition at line 509 of file qgssymbollayer.h.

◆ paintEffect()

QgsPaintEffect * QgsSymbolLayer::paintEffect ( ) const

Returns the current paint effect for the layer.

Returns: paint effect

See also: setPaintEffect

Definition at line 221 of file qgssymbollayer.cpp.

◆ prepareExpressions()

void QgsSymbolLayer::prepareExpressions ( const QgsSymbolRenderContext & context )

virtual

Prepares all data defined property expressions for evaluation.

This should be called prior to evaluating data defined properties.

Parameters

context symbol render context

Reimplemented in QgsSvgMarkerSymbolLayer.

Definition at line 285 of file qgssymbollayer.cpp.

◆ prepareMasks()

void QgsSymbolLayer::prepareMasks ( const QgsSymbolRenderContext & context )

virtual

Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method.

See also: QgsRenderContext::addSymbolLayerClipPath(); QgsRenderContext::symbolLayerClipPaths()

Since: QGIS 3.26

Definition at line 1003 of file qgssymbollayer.cpp.

◆ properties()

virtual QVariantMap QgsSymbolLayer::properties ( ) const

pure virtual

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.

◆ propertyDefinitions()

const QgsPropertiesDefinition & QgsSymbolLayer::propertyDefinitions ( )

static

Returns the symbol layer property definitions.

Definition at line 301 of file qgssymbollayer.cpp.

◆ removeMasks()

void QgsSymbolLayer::removeMasks	(	QgsRenderContext &	context,
		bool	recursive
	)

protected

When rendering, remove previously installed masks from context painter if recursive is true masks are removed recursively for all children symbol layers.

See also: prepareMasks(); installMasks()

Since: QGIS 3.30

Definition at line 1042 of file qgssymbollayer.cpp.

◆ renderingPass()

int QgsSymbolLayer::renderingPass ( ) const

Specifies the rendering pass in which this symbol layer should be rendered.

The lower the number, the lower the symbol will be rendered. 0: first pass, 1: second pass, ... Defaults to 0

Definition at line 332 of file qgssymbollayer.cpp.

◆ restoreOldDataDefinedProperties()

void QgsSymbolLayer::restoreOldDataDefinedProperties ( const QVariantMap & stringMap )

protected

Restores older data defined properties from string map.

Definition at line 371 of file qgssymbollayer.cpp.

◆ setColor()

void QgsSymbolLayer::setColor ( const QColor & color )

virtual

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 in QgsArrowSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsFilledLineSymbolLayer, QgsFilledMarkerSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 261 of file qgssymbollayer.cpp.

◆ setDataDefinedProperties()

void QgsSymbolLayer::setDataDefinedProperties ( const QgsPropertyCollection & collection )

inline

Sets the symbol layer's property collection, used for data defined overrides.

Parameters

collection property collection. Existing properties will be replaced.

See also: dataDefinedProperties()

Definition at line 620 of file qgssymbollayer.h.

◆ setDataDefinedProperty()

void QgsSymbolLayer::setDataDefinedProperty	(	QgsSymbolLayer::Property	key,
		const QgsProperty &	property
	)

virtual

Sets a data defined property for the layer.

Any existing property with the same key will be overwritten.

See also: dataDefinedProperties(); Property

Reimplemented in QgsMarkerLineSymbolLayer, and QgsHashedLineSymbolLayer.

Definition at line 124 of file qgssymbollayer.cpp.

◆ setEnabled()

void QgsSymbolLayer::setEnabled ( bool enabled )

inline

Sets whether symbol layer is enabled and should be drawn.

Disabled layers are not drawn, but remain part of the symbol and can be re-enabled when desired.

See also: enabled()

Definition at line 253 of file qgssymbollayer.h.

◆ setFillColor()

void QgsSymbolLayer::setFillColor ( const QColor & color )

virtual

Sets the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component.

See also: fillColor(); setColor(); setStrokeColor()

Reimplemented in QgsEllipseSymbolLayer, QgsSimpleFillSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsSvgMarkerSymbolLayer.

Definition at line 276 of file qgssymbollayer.cpp.

◆ setId()

void QgsSymbolLayer::setId ( const QString & id )

Set symbol layer identifier This id has to be unique in the whole project.

Since: QGIS 3.30

Definition at line 1062 of file qgssymbollayer.cpp.

◆ setLocked()

void QgsSymbolLayer::setLocked ( bool locked )

inline

Sets whether the layer's colors are locked.

If locked is true then the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

See also: isLocked()

Definition at line 473 of file qgssymbollayer.h.

◆ setMapUnitScale()

virtual void QgsSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

inlinevirtual

◆ setOutputUnit()

virtual void QgsSymbolLayer::setOutputUnit ( Qgis::RenderUnit unit )

inlinevirtual

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

Definition at line 499 of file qgssymbollayer.h.

◆ setPaintEffect()

void QgsSymbolLayer::setPaintEffect ( QgsPaintEffect * effect )

Sets the current paint effect for the layer.

Parameters

effect paint effect. Ownership is transferred to the layer.

See also: paintEffect

Definition at line 226 of file qgssymbollayer.cpp.

◆ setRenderingPass()

void QgsSymbolLayer::setRenderingPass ( int renderingPass )

Specifies the rendering pass in which this symbol layer should be rendered.

The lower the number, the lower the symbol will be rendered. 0: first pass, 1: second pass, ... Defaults to 0

Definition at line 327 of file qgssymbollayer.cpp.

◆ setStrokeColor()

void QgsSymbolLayer::setStrokeColor ( const QColor & color )

virtual

Sets the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component.

See also: strokeColor(); setColor(); setFillColor()

Reimplemented in QgsEllipseSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsFontMarkerSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 266 of file qgssymbollayer.cpp.

◆ setSubSymbol()

bool QgsSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

virtual

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

Reimplemented in QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsArrowSymbolLayer, QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsLinearReferencingSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsFilledLineSymbolLayer, QgsFilledMarkerSymbolLayer, QgsMaskMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 150 of file qgssymbollayer.cpp.

◆ setUserFlags()

void QgsSymbolLayer::setUserFlags ( Qgis::SymbolLayerUserFlags flags )

Sets user-controlled flags which control the symbol layer's behavior.

See also: userFlags()

Since: QGIS 3.34

Definition at line 251 of file qgssymbollayer.cpp.

◆ shouldRenderUsingSelectionColor()

bool QgsSymbolLayer::shouldRenderUsingSelectionColor ( const QgsSymbolRenderContext & context ) const

protected

Returns true if the symbol layer should be rendered using the selection color from the render context.

Since: QGIS 3.34

Definition at line 1057 of file qgssymbollayer.cpp.

◆ startFeatureRender()

void QgsSymbolLayer::startFeatureRender	(	const QgsFeature &	feature,
		QgsRenderContext &	context
	)

virtual

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 in QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsInterpolatedLineSymbolLayer, and QgsTemplatedLineSymbolLayerBase.

Definition at line 129 of file qgssymbollayer.cpp.

◆ startRender()

virtual void QgsSymbolLayer::startRender ( QgsSymbolRenderContext & context )

pure virtual

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

◆ stopFeatureRender()

void QgsSymbolLayer::stopFeatureRender	(	const QgsFeature &	feature,
		QgsRenderContext &	context
	)

virtual

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 in QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsInterpolatedLineSymbolLayer, and QgsTemplatedLineSymbolLayerBase.

Definition at line 137 of file qgssymbollayer.cpp.

◆ stopRender()

virtual void QgsSymbolLayer::stopRender ( QgsSymbolRenderContext & context )

pure virtual

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

◆ strokeColor()

QColor QgsSymbolLayer::strokeColor ( ) const

virtual

Returns the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component. Symbol layers without a stroke component will return an invalid QColor.

See also: setStrokeColor(); color(); fillColor()

Reimplemented in QgsEllipseSymbolLayer, QgsSimpleFillSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, and QgsFontMarkerSymbolLayer.

Definition at line 271 of file qgssymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsSymbolLayer::subSymbol ( )

virtual

Returns the symbol's sub symbol, if present.

Reimplemented in QgsArrowSymbolLayer, QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsLinearReferencingSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsFilledLineSymbolLayer, QgsFilledMarkerSymbolLayer, QgsMaskMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 145 of file qgssymbollayer.cpp.

◆ toSld()

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

inlinevirtual

Saves the symbol layer as SLD.

Reimplemented in QgsEllipseSymbolLayer, QgsSimpleFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsSimpleLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 429 of file qgssymbollayer.h.

◆ type()

Qgis::SymbolType QgsSymbolLayer::type ( ) const

inline

Definition at line 451 of file qgssymbollayer.h.

◆ usedAttributes()

QSet< QString > QgsSymbolLayer::usedAttributes ( const QgsRenderContext & context ) const

virtual

Returns the set of attributes referenced by the layer.

This includes attributes required by any data defined properties associated with the layer.

Reimplemented in QgsArrowSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsCentroidFillSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsMarkerLineSymbolLayer, QgsHashedLineSymbolLayer, QgsFilledLineSymbolLayer, QgsFilledMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsMaskMarkerSymbolLayer, and QgsVectorFieldSymbolLayer.

Definition at line 337 of file qgssymbollayer.cpp.

◆ userFlags()

Qgis::SymbolLayerUserFlags QgsSymbolLayer::userFlags ( ) const

Returns user-controlled flags which control the symbol layer's behavior.

See also: setUserFlags()

Since: QGIS 3.34

Definition at line 246 of file qgssymbollayer.cpp.

◆ usesMapUnits()

bool QgsSymbolLayer::usesMapUnits ( ) const

virtual

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

Since: QGIS 3.18

Definition at line 322 of file qgssymbollayer.cpp.

◆ writeDxf()

bool QgsSymbolLayer::writeDxf	(	QgsDxfExport &	e,
		double	mmMapUnitScaleFactor,
		const QString &	layerName,
		QgsSymbolRenderContext &	context,
		QPointF	shift = `QPointF( 0.0, 0.0 )`
	)		const

virtual

write as DXF

Reimplemented in QgsEllipseSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsSvgMarkerSymbolLayer.

Definition at line 156 of file qgssymbollayer.cpp.

Member Data Documentation

◆ mClipPath

QPainterPath QgsSymbolLayer::mClipPath

protected

Definition at line 703 of file qgssymbollayer.h.

◆ mColor

QColor QgsSymbolLayer::mColor

protected

Definition at line 694 of file qgssymbollayer.h.

◆ mDataDefinedProperties

QgsPropertyCollection QgsSymbolLayer::mDataDefinedProperties

protected

Definition at line 697 of file qgssymbollayer.h.

◆ mEnabled

bool QgsSymbolLayer::mEnabled = true

protected

True if layer is enabled and should be drawn.

Definition at line 688 of file qgssymbollayer.h.

◆ mFields

QgsFields QgsSymbolLayer::mFields

protected

Definition at line 700 of file qgssymbollayer.h.

◆ mId

QString QgsSymbolLayer::mId

protected

Definition at line 696 of file qgssymbollayer.h.

◆ mLocked

bool QgsSymbolLayer::mLocked = false

protected

Definition at line 693 of file qgssymbollayer.h.

◆ mPaintEffect

std::unique_ptr< QgsPaintEffect > QgsSymbolLayer::mPaintEffect

protected

Definition at line 699 of file qgssymbollayer.h.

◆ mRenderingPass

int QgsSymbolLayer::mRenderingPass = 0

protected

Definition at line 695 of file qgssymbollayer.h.

◆ mType

Qgis::SymbolType QgsSymbolLayer::mType

protected

Definition at line 685 of file qgssymbollayer.h.

◆ mUserFlags

Qgis::SymbolLayerUserFlags QgsSymbolLayer::mUserFlags

protected

User controlled flags.

Definition at line 691 of file qgssymbollayer.h.

◆ SELECT_FILL_BORDER

const bool QgsSymbolLayer::SELECT_FILL_BORDER = false

staticprotected

Whether fill styles for selected features also highlight symbol stroke.

Definition at line 709 of file qgssymbollayer.h.

◆ SELECT_FILL_STYLE

const bool QgsSymbolLayer::SELECT_FILL_STYLE = false

staticprotected

Whether fill styles for selected features uses symbol layer style.

Definition at line 711 of file qgssymbollayer.h.

◆ SELECTION_IS_OPAQUE

const bool QgsSymbolLayer::SELECTION_IS_OPAQUE = true

staticprotected

Whether styles for selected features ignore symbol alpha.

Definition at line 707 of file qgssymbollayer.h.

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

/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/symbology/qgssymbollayer.h
/build/qgis-3.41.0+git20241110+fda2aa46e9a+99sid/src/core/symbology/qgssymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ Property

Constructor & Destructor Documentation

◆ ~QgsSymbolLayer()

◆ QgsSymbolLayer() [1/2]

◆ QgsSymbolLayer() [2/2]

Member Function Documentation

◆ canCauseArtifactsBetweenAdjacentTiles()

◆ clone()

◆ color()

◆ copyDataDefinedProperties()

◆ copyPaintEffect()

◆ dataDefinedProperties() [1/2]

◆ dataDefinedProperties() [2/2]

◆ drawPreviewIcon()

◆ dxfAngle()

◆ dxfBrushColor()

◆ dxfBrushStyle()

◆ dxfColor()

◆ dxfCustomDashPattern()

◆ dxfOffset()

◆ dxfPenStyle()

◆ dxfSize()

◆ dxfWidth()

◆ enabled()

◆ estimateMaxBleed()

◆ fillColor()

◆ flags()

◆ hasDataDefinedProperties()

◆ id()

◆ installMasks()

◆ isCompatibleWithSymbol()

◆ isLocked()

◆ layerType()

◆ mapUnitScale()

◆ masks()

◆ ogrFeatureStyle()

◆ operator=()

◆ outputUnit()

◆ paintEffect()

◆ prepareExpressions()

◆ prepareMasks()

◆ properties()

◆ propertyDefinitions()

◆ removeMasks()

◆ renderingPass()

◆ restoreOldDataDefinedProperties()

◆ setColor()

◆ setDataDefinedProperties()

◆ setDataDefinedProperty()

◆ setEnabled()

◆ setFillColor()

◆ setId()

◆ setLocked()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setPaintEffect()

◆ setRenderingPass()

◆ setStrokeColor()

◆ setSubSymbol()

◆ setUserFlags()

◆ shouldRenderUsingSelectionColor()

◆ startFeatureRender()

◆ startRender()

◆ stopFeatureRender()

◆ stopRender()

◆ strokeColor()

◆ subSymbol()

◆ toSld()

◆ type()

◆ usedAttributes()

◆ userFlags()

◆ usesMapUnits()