Base class for polygon renderers generating texture images. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsImageFillSymbolLayer:

[legend]

Public Member Functions
	QgsImageFillSymbolLayer ()

	~QgsImageFillSymbolLayer () override

Qgis::SymbolCoordinateReference	coordinateReference () const
	Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature.

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

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

QgsMapUnitScale	mapUnitScale () const override

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

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

void	renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) override
	Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.

void	setCoordinateReference (Qgis::SymbolCoordinateReference coordinateReference)
	Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature.

void	setMapUnitScale (const QgsMapUnitScale &scale) override

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

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

void	setStrokeWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's stroke width.

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

Qgis::RenderUnit	strokeWidthUnit () const
	Returns the units for the symbol's stroke width.

Public Member Functions inherited from QgsFillSymbolLayer
	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

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 double	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets marker size.

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

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.

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.

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

Protected Member Functions
virtual bool	applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const
	Returns `true` if the image brush should be transformed using the render context's texture origin.

virtual void	applyDataDefinedSettings (QgsSymbolRenderContext &context)
	Applies data defined settings prior to generating the fill symbol brush.

Protected Member Functions inherited from QgsFillSymbolLayer
	QgsFillSymbolLayer (bool locked=false)

void	_renderPolygon (QPainter p, const QPolygonF &points, const QVector< QPolygonF > rings, QgsSymbolRenderContext &context)
	Default method to render polygon.

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
QBrush	mBrush

Qgis::SymbolCoordinateReference	mCoordinateReference = Qgis::SymbolCoordinateReference::Feature

double	mNextAngle = 0.0

double	mStrokeWidth = 0.0
	Stroke width.

QgsMapUnitScale	mStrokeWidthMapUnitScale

Qgis::RenderUnit	mStrokeWidthUnit = Qgis::RenderUnit::Millimeters

Protected Attributes inherited from QgsFillSymbolLayer
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 }
	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

Base class for polygon renderers generating texture images.

Definition at line 756 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::QgsImageFillSymbolLayer ( )

Definition at line 1780 of file qgsfillsymbollayer.cpp.

◆ ~QgsImageFillSymbolLayer()

QgsImageFillSymbolLayer::~QgsImageFillSymbolLayer ( )

overridedefault

Member Function Documentation

◆ applyBrushTransformFromContext()

bool QgsImageFillSymbolLayer::applyBrushTransformFromContext ( QgsSymbolRenderContext * context = nullptr ) const

protectedvirtual

Returns true if the image brush should be transformed using the render context's texture origin.

Since: QGIS 3.16

Reimplemented in QgsRasterFillSymbolLayer.

Definition at line 1887 of file qgsfillsymbollayer.cpp.

◆ applyDataDefinedSettings()

virtual void QgsImageFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext & context )

inlineprotectedvirtual

Applies data defined settings prior to generating the fill symbol brush.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 835 of file qgsfillsymbollayer.h.

◆ coordinateReference()

Qgis::SymbolCoordinateReference QgsImageFillSymbolLayer::coordinateReference ( ) const

inline

Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature.

Returns: coordinate reference mode

See also: setCoordinateReference

Since: QGIS 3.24

Definition at line 812 of file qgsfillsymbollayer.h.

◆ dxfPenStyle()

Qt::PenStyle QgsImageFillSymbolLayer::dxfPenStyle ( ) const

overridevirtual

Gets pen style.

Reimplemented from QgsSymbolLayer.

Definition at line 1865 of file qgsfillsymbollayer.cpp.

◆ dxfWidth()

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

overridevirtual

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 1854 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsImageFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1849 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsImageFillSymbolLayer::outputUnit ( ) const

overridevirtual

Returns the units to use for sizes and widths within the symbol layer.

Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.

Returns: output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units

See also: setOutputUnit()

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1839 of file qgsfillsymbollayer.cpp.

◆ properties()

QVariantMap QgsImageFillSymbolLayer::properties ( ) const

overridevirtual

Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

This is used to serialize a symbol layer perstistently.

Implements QgsSymbolLayer.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1880 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

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

overridevirtual

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

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

Implements QgsFillSymbolLayer.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1786 of file qgsfillsymbollayer.cpp.

◆ setCoordinateReference()

void QgsImageFillSymbolLayer::setCoordinateReference ( Qgis::SymbolCoordinateReference coordinateReference )

inline

Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature.

Parameters

coordinateReference coordinate reference mode

See also: coordinateReference

Since: QGIS 3.24

Definition at line 803 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsImageFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1844 of file qgsfillsymbollayer.cpp.

◆ setOutputUnit()

void QgsImageFillSymbolLayer::setOutputUnit ( Qgis::RenderUnit unit )

overridevirtual

Sets the units to use for sizes and widths within the symbol layer.

Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.

Parameters

unit	output units

See also: outputUnit()

Reimplemented from QgsSymbolLayer.

Reimplemented in QgsRasterFillSymbolLayer, QgsSVGFillSymbolLayer, QgsLinePatternFillSymbolLayer, and QgsPointPatternFillSymbolLayer.

Definition at line 1834 of file qgsfillsymbollayer.cpp.

◆ setStrokeWidthMapUnitScale()

void QgsImageFillSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the stroke width map unit scale.

See also: strokeWidthMapUnitScale(); setStrokeWidthUnit()

Definition at line 785 of file qgsfillsymbollayer.h.

◆ setStrokeWidthUnit()

void QgsImageFillSymbolLayer::setStrokeWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the symbol's stroke width.

See also: strokeWidthUnit(); setStrokeWidthMapUnitScale()

Definition at line 770 of file qgsfillsymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsImageFillSymbolLayer::strokeWidthMapUnitScale ( ) const

inline

Returns the stroke width map unit scale.

See also: setStrokeWidthMapUnitScale(); strokeWidthUnit()

Definition at line 794 of file qgsfillsymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsImageFillSymbolLayer::strokeWidthUnit ( ) const

inline

Returns the units for the symbol's stroke width.

See also: setStrokeWidthUnit(); strokeWidthMapUnitScale()

Definition at line 777 of file qgsfillsymbollayer.h.

Member Data Documentation

◆ mBrush

QBrush QgsImageFillSymbolLayer::mBrush

protected

Definition at line 823 of file qgsfillsymbollayer.h.

◆ mCoordinateReference

Qgis::SymbolCoordinateReference QgsImageFillSymbolLayer::mCoordinateReference = Qgis::SymbolCoordinateReference::Feature

protected

Definition at line 824 of file qgsfillsymbollayer.h.

◆ mNextAngle

double QgsImageFillSymbolLayer::mNextAngle = 0.0

protected

Definition at line 825 of file qgsfillsymbollayer.h.

◆ mStrokeWidth

double QgsImageFillSymbolLayer::mStrokeWidth = 0.0

protected

Stroke width.

Definition at line 828 of file qgsfillsymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsImageFillSymbolLayer::mStrokeWidthMapUnitScale

protected

Definition at line 830 of file qgsfillsymbollayer.h.

◆ mStrokeWidthUnit

Qgis::RenderUnit QgsImageFillSymbolLayer::mStrokeWidthUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 829 of file qgsfillsymbollayer.h.

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

/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.41.0+git20241225+af5edcb665c+99sid/src/core/symbology/qgsfillsymbollayer.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsImageFillSymbolLayer()

◆ ~QgsImageFillSymbolLayer()

Member Function Documentation

◆ applyBrushTransformFromContext()

◆ applyDataDefinedSettings()

◆ coordinateReference()

◆ dxfPenStyle()

◆ dxfWidth()

◆ mapUnitScale()

◆ outputUnit()

◆ properties()

◆ renderPolygon()

◆ setCoordinateReference()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setStrokeWidthMapUnitScale()

◆ setStrokeWidthUnit()

◆ strokeWidthMapUnitScale()

◆ strokeWidthUnit()

Member Data Documentation

◆ mBrush

◆ mCoordinateReference

◆ mNextAngle

◆ mStrokeWidth

◆ mStrokeWidthMapUnitScale

◆ mStrokeWidthUnit