Abstract base class for fill symbol layers. More...

#include <qgssymbollayer.h>

Inheritance diagram for QgsFillSymbolLayer:

[legend]

Public Member Functions
	QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete
double	angle () const
	Returns the rotation angle of the fill symbol, in degrees clockwise.
void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
QgsFillSymbolLayer &	operator= (const QgsFillSymbolLayer &other)=delete
virtual void	renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)=0
	Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.
void	setAngle (double angle)
	Sets the rotation angle of the pattern, in degrees clockwise.
virtual QImage	toTiledPatternImage () const
	Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills.
Public Member Functions inherited from QgsSymbolLayer
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 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 bool	rendersIdenticallyTo (const QgsSymbolLayer *other) const
	Returns `true` if this symbol layer will always render identically to an other symbol layer.
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 Q_DECL_DEPRECATED void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
	Saves the symbol layer as SLD.
virtual bool	toSld (QDomDocument &doc, QDomElement &element, QgsSldExportContext &context) 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

Protected Member Functions
	QgsFillSymbolLayer (bool locked=false)
void	_renderPolygon (QPainter p, const QPolygonF &points, const QVector< QPolygonF > rings, QgsSymbolRenderContext &context)
	Default method to render polygon.
Protected Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)
	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
double	mAngle = 0.0
Protected Attributes inherited from QgsSymbolLayer
QPainterPath	mClipPath
QColor	mColor
QgsPropertyCollection	mDataDefinedProperties
bool	mEnabled = true
	True if layer is enabled and should be drawn.
QgsFields	mFields
QString	mId
bool	mLocked = false
std::unique_ptr< QgsPaintEffect >	mPaintEffect
int	mRenderingPass = 0
Qgis::SymbolType	mType
Qgis::SymbolLayerUserFlags	mUserFlags
	User controlled flags.

Additional Inherited Members
Public Types inherited from QgsSymbolLayer
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 , BlankSegments }
	Data definable properties. More...
Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions.
Static Protected Attributes inherited from QgsSymbolLayer
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

Abstract base class for fill symbol layers.

Definition at line 1314 of file qgssymbollayer.h.

Constructor & Destructor Documentation

◆ QgsFillSymbolLayer() [1/2]

QgsFillSymbolLayer::QgsFillSymbolLayer ( const QgsFillSymbolLayer & other )

delete

◆ QgsFillSymbolLayer() [2/2]

QgsFillSymbolLayer::QgsFillSymbolLayer ( bool locked = false )

protected

Definition at line 578 of file qgssymbollayer.cpp.

Member Function Documentation

◆ _renderPolygon()

void QgsFillSymbolLayer::_renderPolygon	(	QPainter *	p,
		const QPolygonF &	points,
		const QVector< QPolygonF > *	rings,
		QgsSymbolRenderContext &	context )

protected

Default method to render polygon.

Definition at line 931 of file qgssymbollayer.cpp.

◆ angle()

double QgsFillSymbolLayer::angle ( ) const

inline

Returns the rotation angle of the fill symbol, in degrees clockwise.

Note: Not all fill symbol layers support rotation.

See also: setAngle()

Definition at line 1346 of file qgssymbollayer.h.

◆ drawPreviewIcon()

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

overridevirtual

Implements QgsSymbolLayer.

Definition at line 901 of file qgssymbollayer.cpp.

◆ operator=()

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

delete

◆ renderPolygon()

virtual void QgsFillSymbolLayer::renderPolygon	(	const QPolygonF &	points,
		const QVector< QPolygonF > *	rings,
		QgsSymbolRenderContext &	context )

pure virtual

Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.

The rings argument optionally specifies a list of polygon rings to render as holes.

Implemented in QgsCentroidFillSymbolLayer, QgsGradientFillSymbolLayer, QgsImageFillSymbolLayer, QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, QgsRandomMarkerFillSymbolLayer, QgsRasterFillSymbolLayer, QgsShapeburstFillSymbolLayer, QgsSimpleFillSymbolLayer, and QgsSVGFillSymbolLayer.

◆ setAngle()

void QgsFillSymbolLayer::setAngle ( double angle )

inline

Sets the rotation angle of the pattern, in degrees clockwise.

Note: Not all fill symbol layers support rotation.

See also: angle()

Definition at line 1337 of file qgssymbollayer.h.

◆ toTiledPatternImage()

QImage QgsFillSymbolLayer::toTiledPatternImage ( ) const

virtual

Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills.

The default implementation returns a null image.

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

Since: QGIS 3.30

Reimplemented in QgsLinePatternFillSymbolLayer, QgsPointPatternFillSymbolLayer, and QgsSimpleFillSymbolLayer.

Definition at line 926 of file qgssymbollayer.cpp.

Member Data Documentation

◆ mAngle

double QgsFillSymbolLayer::mAngle = 0.0

protected

Definition at line 1365 of file qgssymbollayer.h.

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

/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/symbology/qgssymbollayer.h
/build/qgis-3.99.0+git20251210+2fe06baccd8+99sid/src/core/symbology/qgssymbollayer.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsFillSymbolLayer() [1/2]

◆ QgsFillSymbolLayer() [2/2]

Member Function Documentation

◆ _renderPolygon()

◆ angle()

◆ drawPreviewIcon()

◆ operator=()

◆ renderPolygon()

◆ setAngle()

◆ toTiledPatternImage()

Member Data Documentation

◆ mAngle