#include <qgssymbollayer.h>

Inheritance diagram for QgsSymbolLayer:

[legend]

Public Types
enum	Property { PropertySize = 0 , PropertyAngle , PropertyName , PropertyFillColor , PropertyStrokeColor , PropertyStrokeWidth , PropertyStrokeStyle , PropertyOffset , PropertyCharacter , PropertyWidth , PropertyHeight , PropertyPreserveAspectRatio , PropertyFillStyle , PropertyJoinStyle , PropertySecondaryColor , PropertyLineAngle , PropertyLineDistance , PropertyGradientType , PropertyCoordinateMode , PropertyGradientSpread , PropertyGradientReference1X , PropertyGradientReference1Y , PropertyGradientReference2X , PropertyGradientReference2Y , PropertyGradientReference1IsCentroid , PropertyGradientReference2IsCentroid , PropertyBlurRadius , PropertyShapeburstUseWholeShape , PropertyShapeburstMaxDistance , PropertyShapeburstIgnoreRings , PropertyFile , PropertyDistanceX , PropertyDistanceY , PropertyDisplacementX , PropertyDisplacementY , PropertyOpacity , PropertyCustomDash , PropertyCapStyle , PropertyPlacement , PropertyInterval , PropertyOffsetAlongLine , PropertyAverageAngleLength , PropertyHorizontalAnchor , PropertyVerticalAnchor , PropertyLayerEnabled , PropertyArrowWidth , PropertyArrowStartWidth , PropertyArrowHeadLength , PropertyArrowHeadThickness , PropertyArrowHeadType , PropertyArrowType , PropertyOffsetX , PropertyOffsetY , PropertyPointCount , PropertyRandomSeed , PropertyClipPoints , PropertyDensityArea , PropertyFontFamily , PropertyFontStyle , PropertyDashPatternOffset , PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue , PropertyLineStartColorValue , PropertyLineEndColorValue }
	Data definable properties. More...

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

virtual	~QgsSymbolLayer ()

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

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

virtual QColor	color () const
	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 void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0

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

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

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

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

virtual QVector< qreal >	dxfCustomDashPattern (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...

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

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

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

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

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

virtual QgsMapUnitScale	mapUnitScale () const

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

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

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

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

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

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

virtual void	setColor (const QColor &color)
	The fill color. 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 bool	setSubSymbol (QgsSymbol *symbol)
	Sets layer's subsymbol. takes ownership of the passed symbol. More...

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

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

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

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

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

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

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

Qgis::SymbolType	type () const

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

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

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

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

Protected Member Functions
	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
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
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 53 of file qgssymbollayer.h.

Member Enumeration Documentation

◆ Property

enum QgsSymbolLayer::Property

Data definable properties.

Since: QGIS 3.0

Enumerator
PropertySize	Symbol size.
PropertyAngle	Symbol angle.
PropertyName	Name, eg shape name for simple markers.
PropertyFillColor	Fill color.
PropertyStrokeColor	Stroke color.
PropertyStrokeWidth	Stroke width.
PropertyStrokeStyle	Stroke style (eg solid, dashed)
PropertyOffset	Symbol offset.
PropertyCharacter	Character, eg for font marker symbol layers.
PropertyWidth	Symbol width.
PropertyHeight	Symbol height.
PropertyPreserveAspectRatio	Preserve aspect ratio between width and height.
PropertyFillStyle	Fill style (eg solid, dots)
PropertyJoinStyle	Line join style.
PropertySecondaryColor	Secondary color (eg for gradient fills)
PropertyLineAngle	Line angle, or angle of hash lines for hash line symbols.
PropertyLineDistance	Distance between lines, or length of lines for hash line symbols.
PropertyGradientType	Gradient fill type.
PropertyCoordinateMode	Gradient coordinate mode.
PropertyGradientSpread	Gradient spread mode.
PropertyGradientReference1X	Gradient reference point 1 x.
PropertyGradientReference1Y	Gradient reference point 1 y.
PropertyGradientReference2X	Gradient reference point 2 x.
PropertyGradientReference2Y	Gradient reference point 2 y.
PropertyGradientReference1IsCentroid	Gradient reference point 1 is centroid.
PropertyGradientReference2IsCentroid	Gradient reference point 2 is centroid.
PropertyBlurRadius	Shapeburst blur radius.
PropertyShapeburstUseWholeShape	Shapeburst use whole shape.
PropertyShapeburstMaxDistance	Shapeburst fill from edge distance.
PropertyShapeburstIgnoreRings	Shapeburst ignore rings.
PropertyFile	Filename, eg for svg files.
PropertyDistanceX	Horizontal distance between points.
PropertyDistanceY	Vertical distance between points.
PropertyDisplacementX	Horizontal displacement.
PropertyDisplacementY	Vertical displacement.
PropertyOpacity	Opacity.
PropertyCustomDash	Custom dash pattern.
PropertyCapStyle	Line cap style.
PropertyPlacement	Line marker placement.
PropertyInterval	Line marker interval.
PropertyOffsetAlongLine	Offset along line.
PropertyAverageAngleLength	Length to average symbol angles over.
PropertyHorizontalAnchor	Horizontal anchor point.
PropertyVerticalAnchor	Vertical anchor point.
PropertyLayerEnabled	Whether symbol layer is enabled.
PropertyArrowWidth	Arrow tail width.
PropertyArrowStartWidth	Arrow tail start width.
PropertyArrowHeadLength	Arrow head length.
PropertyArrowHeadThickness	Arrow head thickness.
PropertyArrowHeadType	Arrow head type.
PropertyArrowType	Arrow type.
PropertyOffsetX	Horizontal offset.
PropertyOffsetY	Vertical offset.
PropertyPointCount	Point count.
PropertyRandomSeed	Random number seed.
PropertyClipPoints	Whether markers should be clipped to polygon boundaries.
PropertyDensityArea	Density area.
PropertyFontFamily	Font family.
PropertyFontStyle	Font style.
PropertyDashPatternOffset	Dash pattern offset,.
PropertyTrimStart	Trim distance from start of line (since QGIS 3.20)
PropertyTrimEnd	Trim distance from end of line (since QGIS 3.20)
PropertyLineStartWidthValue	Start line width for interpolated line renderer (since QGIS 3.22)
PropertyLineEndWidthValue	End line width for interpolated line renderer (since QGIS 3.22)
PropertyLineStartColorValue	Start line color for interpolated line renderer (since QGIS 3.22)
PropertyLineEndColorValue	End line color for interpolated line renderer (since QGIS 3.22)

Definition at line 135 of file qgssymbollayer.h.

Constructor & Destructor Documentation

◆ ~QgsSymbolLayer()

QgsSymbolLayer::~QgsSymbolLayer ( )

virtualdefault

◆ QgsSymbolLayer() [1/2]

QgsSymbolLayer::QgsSymbolLayer ( const QgsSymbolLayer & other )

delete

QgsSymbolLayer cannot be copied.

◆ 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 221 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 QgsTemplatedLineSymbolLayerBase, QgsSimpleLineSymbolLayer, QgsInterpolatedLineSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsGradientFillSymbolLayer, and QgsArrowSymbolLayer.

Definition at line 264 of file qgssymbollayer.cpp.

◆ clone()

virtual QgsSymbolLayer* QgsSymbolLayer::clone ( ) const

pure virtual

◆ color()

virtual QColor QgsSymbolLayer::color ( ) const

inlinevirtual

The fill color.

Reimplemented in QgsVectorFieldSymbolLayer, QgsFilledMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsArrowSymbolLayer.

Definition at line 245 of file qgssymbollayer.h.

◆ 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 439 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

Since: QGIS 2.9

Definition at line 447 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

Since: QGIS 3.0

Definition at line 535 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()

Since: QGIS 3.0

Definition at line 542 of file qgssymbollayer.h.

◆ drawPreviewIcon()

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

pure virtual

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

◆ dxfAngle()

double QgsSymbolLayer::dxfAngle ( QgsSymbolRenderContext & context ) const

virtual

Gets angle.

Reimplemented in QgsSimpleFillSymbolLayer.

Definition at line 180 of file qgssymbollayer.cpp.

◆ dxfBrushColor()

QColor QgsSymbolLayer::dxfBrushColor ( QgsSymbolRenderContext & context ) const

virtual

Gets brush/fill color.

Reimplemented in QgsSimpleFillSymbolLayer.

Definition at line 197 of file qgssymbollayer.cpp.

◆ dxfBrushStyle()

Qt::BrushStyle QgsSymbolLayer::dxfBrushStyle ( ) const

virtual

Gets brush/fill style.

Reimplemented in QgsSimpleFillSymbolLayer.

Definition at line 203 of file qgssymbollayer.cpp.

◆ dxfColor()

QColor QgsSymbolLayer::dxfColor ( QgsSymbolRenderContext & context ) const

virtual

Gets color.

Reimplemented in QgsSimpleLineSymbolLayer, QgsImageFillSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 174 of file qgssymbollayer.cpp.

◆ dxfCustomDashPattern()

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

virtual

Gets dash pattern.

Reimplemented in QgsSimpleLineSymbolLayer.

Definition at line 186 of file qgssymbollayer.cpp.

◆ dxfOffset()

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

virtual

Gets offset.

Reimplemented in QgsSimpleLineSymbolLayer.

Definition at line 167 of file qgssymbollayer.cpp.

◆ dxfPenStyle()

Qt::PenStyle QgsSymbolLayer::dxfPenStyle ( ) const

virtual

Gets pen style.

Reimplemented in QgsSimpleLineSymbolLayer, QgsImageFillSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 192 of file qgssymbollayer.cpp.

◆ dxfWidth()

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

virtual

Gets line width.

Reimplemented in QgsLineSymbolLayer, QgsSimpleLineSymbolLayer, QgsImageFillSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 160 of file qgssymbollayer.cpp.

◆ enabled()

bool QgsSymbolLayer::enabled ( ) const

inline

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

See also: setEnabled()

Since: QGIS 3.0

Definition at line 231 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 QgsFilledMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsSimpleLineSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsRasterFillSymbolLayer, QgsImageFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsGradientFillSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 415 of file qgssymbollayer.h.

◆ fillColor()

virtual QColor QgsSymbolLayer::fillColor ( ) const

inlinevirtual

Gets fill color.

Supported by marker and fill layers.

Since: QGIS 2.1

Reimplemented in QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSimpleFillSymbolLayer, and QgsEllipseSymbolLayer.

Definition at line 274 of file qgssymbollayer.h.

◆ flags()

Qgis::SymbolLayerFlags QgsSymbolLayer::flags ( ) const

virtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented in QgsInterpolatedLineSymbolLayer.

Definition at line 227 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 QgsVectorFieldSymbolLayer, QgsMaskMarkerSymbolLayer, QgsFilledMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsImageFillSymbolLayer, and QgsArrowSymbolLayer.

Definition at line 243 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 QgsInterpolatedLineSymbolLayer, and QgsGeometryGeneratorSymbolLayer.

Definition at line 256 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 406 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 860 of file qgssymbollayer.cpp.

◆ ogrFeatureStyle()

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

inlinevirtual

Reimplemented in QgsSimpleMarkerSymbolLayer, QgsSimpleLineSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 358 of file qgssymbollayer.h.

◆ operator=()

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

delete

QgsSymbolLayer cannot be copied.

◆ outputUnit()

virtual QgsUnitTypes::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()

Reimplemented in QgsVectorFieldSymbolLayer, QgsLineSymbolLayer, QgsMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSimpleLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsSVGFillSymbolLayer, QgsImageFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsGradientFillSymbolLayer, QgsSimpleFillSymbolLayer, QgsEllipseSymbolLayer, and QgsTemplatedLineSymbolLayerBase.

Definition at line 435 of file qgssymbollayer.h.

◆ paintEffect()

QgsPaintEffect * QgsSymbolLayer::paintEffect ( ) const

Returns the current paint effect for the layer.

Returns: paint effect

See also: setPaintEffect

Since: QGIS 2.9

Definition at line 208 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

Since: QGIS 2.12

Reimplemented in QgsSvgMarkerSymbolLayer.

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

Implemented in QgsVectorFieldSymbolLayer, QgsMaskMarkerSymbolLayer, QgsFontMarkerSymbolLayer, QgsRasterMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsFilledMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsTemplatedLineSymbolLayerBase, QgsSimpleLineSymbolLayer, QgsInterpolatedLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsSVGFillSymbolLayer, QgsRasterFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsGradientFillSymbolLayer, QgsSimpleFillSymbolLayer, QgsEllipseSymbolLayer, and QgsArrowSymbolLayer.

◆ propertyDefinitions()

const QgsPropertiesDefinition & QgsSymbolLayer::propertyDefinitions ( )

static

Returns the symbol layer property definitions.

Since: QGIS 3.0

Definition at line 248 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 279 of file qgssymbollayer.cpp.

◆ restoreOldDataDefinedProperties()

void QgsSymbolLayer::restoreOldDataDefinedProperties ( const QVariantMap & stringMap )

protected

Restores older data defined properties from string map.

Since: QGIS 3.0

Definition at line 318 of file qgssymbollayer.cpp.

◆ setColor()

virtual void QgsSymbolLayer::setColor ( const QColor & color )

inlinevirtual

The fill color.

Reimplemented in QgsVectorFieldSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsFilledMarkerSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsArrowSymbolLayer.

Definition at line 250 of file qgssymbollayer.h.

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

Since: QGIS 3.0

Definition at line 550 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

Since: QGIS 3.0

Reimplemented in QgsHashedLineSymbolLayer, and QgsMarkerLineSymbolLayer.

Definition at line 122 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()

Since: QGIS 3.0

Definition at line 240 of file qgssymbollayer.h.

◆ setFillColor()

virtual void QgsSymbolLayer::setFillColor ( const QColor & color )

inlinevirtual

Set fill color.

Supported by marker and fill layers.

Since: QGIS 2.1

Reimplemented in QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsSimpleFillSymbolLayer, and QgsEllipseSymbolLayer.

Definition at line 268 of file qgssymbollayer.h.

◆ 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 399 of file qgssymbollayer.h.

◆ setMapUnitScale()

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

inlinevirtual

◆ setOutputUnit()

virtual void QgsSymbolLayer::setOutputUnit ( QgsUnitTypes::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()

Reimplemented in QgsVectorFieldSymbolLayer, QgsLineSymbolLayer, QgsMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsSimpleLineSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsSVGFillSymbolLayer, QgsImageFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsGradientFillSymbolLayer, QgsSimpleFillSymbolLayer, and QgsEllipseSymbolLayer.

Definition at line 425 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

Since: QGIS 2.9

Definition at line 213 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 274 of file qgssymbollayer.cpp.

◆ setStrokeColor()

virtual void QgsSymbolLayer::setStrokeColor ( const QColor & color )

inlinevirtual

Set stroke color.

Supported by marker and fill layers.

Since: QGIS 2.1

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

Definition at line 256 of file qgssymbollayer.h.

◆ setSubSymbol()

bool QgsSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

virtual

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

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

Definition at line 144 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 QgsInterpolatedLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, and QgsRandomMarkerFillSymbolLayer.

Definition at line 127 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 QgsInterpolatedLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, and QgsRandomMarkerFillSymbolLayer.

Definition at line 133 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()

virtual QColor QgsSymbolLayer::strokeColor ( ) const

inlinevirtual

Gets stroke color.

Supported by marker and fill layers.

Since: QGIS 2.1

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

Definition at line 262 of file qgssymbollayer.h.

◆ subSymbol()

QgsSymbol * QgsSymbolLayer::subSymbol ( )

virtual

Returns the symbol's sub symbol, if present.

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

Definition at line 139 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 QgsVectorFieldSymbolLayer, QgsMarkerSymbolLayer, QgsMarkerLineSymbolLayer, QgsSimpleLineSymbolLayer, QgsCentroidFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsSVGFillSymbolLayer, QgsSimpleFillSymbolLayer, and QgsEllipseSymbolLayer.

Definition at line 355 of file qgssymbollayer.h.

◆ type()

Qgis::SymbolType QgsSymbolLayer::type ( ) const

inline

Definition at line 377 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 QgsVectorFieldSymbolLayer, QgsMaskMarkerSymbolLayer, QgsSvgMarkerSymbolLayer, QgsFilledMarkerSymbolLayer, QgsHashedLineSymbolLayer, QgsMarkerLineSymbolLayer, QgsGeometryGeneratorSymbolLayer, QgsCentroidFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsImageFillSymbolLayer, and QgsArrowSymbolLayer.

Definition at line 284 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 269 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 QgsSvgMarkerSymbolLayer, QgsSimpleMarkerSymbolLayer, and QgsEllipseSymbolLayer.

Definition at line 150 of file qgssymbollayer.cpp.

Member Data Documentation

◆ mColor

QColor QgsSymbolLayer::mColor

protected

Definition at line 581 of file qgssymbollayer.h.

◆ mDataDefinedProperties

QgsPropertyCollection QgsSymbolLayer::mDataDefinedProperties

protected

Definition at line 584 of file qgssymbollayer.h.

◆ mEnabled

bool QgsSymbolLayer::mEnabled = true

protected

True if layer is enabled and should be drawn.

Definition at line 578 of file qgssymbollayer.h.

◆ mFields

QgsFields QgsSymbolLayer::mFields

protected

Definition at line 587 of file qgssymbollayer.h.

◆ mLocked

bool QgsSymbolLayer::mLocked = false

protected

Definition at line 580 of file qgssymbollayer.h.

◆ mPaintEffect

std::unique_ptr< QgsPaintEffect > QgsSymbolLayer::mPaintEffect

protected

Definition at line 586 of file qgssymbollayer.h.

◆ mRenderingPass

int QgsSymbolLayer::mRenderingPass = 0

protected

Definition at line 582 of file qgssymbollayer.h.

◆ mType

Qgis::SymbolType QgsSymbolLayer::mType

protected

Definition at line 575 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 593 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 595 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 591 of file qgssymbollayer.h.

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

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

◆ dxfWidth()

◆ enabled()

◆ estimateMaxBleed()

◆ fillColor()

◆ flags()

◆ hasDataDefinedProperties()

◆ isCompatibleWithSymbol()

◆ isLocked()

◆ layerType()

◆ mapUnitScale()

◆ masks()

◆ ogrFeatureStyle()

◆ operator=()

◆ outputUnit()

◆ paintEffect()

◆ prepareExpressions()

◆ properties()

◆ propertyDefinitions()

◆ renderingPass()

◆ restoreOldDataDefinedProperties()

◆ setColor()

◆ setDataDefinedProperties()

◆ setDataDefinedProperty()

◆ setEnabled()

◆ setFillColor()

◆ setLocked()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setPaintEffect()

◆ setRenderingPass()

◆ setStrokeColor()

◆ setSubSymbol()

◆ startFeatureRender()

◆ startRender()

◆ stopFeatureRender()

◆ stopRender()

◆ strokeColor()

◆ subSymbol()

◆ toSld()

◆ type()

◆ usedAttributes()

◆ usesMapUnits()

◆ writeDxf()

Member Data Documentation

◆ mColor

◆ mDataDefinedProperties

◆ mEnabled

◆ mFields

◆ mLocked

◆ mPaintEffect

◆ mRenderingPass