A fill symbol layer which draws a smooth color gradient over a polygon. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsGradientFillSymbolLayer:

[legend]

Public Member Functions
	QgsGradientFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, Qgis::GradientColorSource gradientColorType=Qgis::GradientColorSource::SimpleTwoColor, Qgis::GradientType gradientType=Qgis::GradientType::Linear, Qgis::SymbolCoordinateReference coordinateMode=Qgis::SymbolCoordinateReference::Feature, Qgis::GradientSpread gradientSpread=Qgis::GradientSpread::Pad)
	Constructor for QgsGradientFillSymbolLayer.

	~QgsGradientFillSymbolLayer () override

bool	canCauseArtifactsBetweenAdjacentTiles () const override
	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.

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

QColor	color2 () const
	Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.

QgsColorRamp *	colorRamp ()
	Returns the color ramp used for the gradient fill.

Qgis::SymbolCoordinateReference	coordinateMode () const
	Returns the coordinate mode for gradient, which controls how the gradient stops are positioned.

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

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

Qgis::GradientColorSource	gradientColorType () const
	Returns the gradient color mode, which controls how gradient color stops are created.

Qgis::GradientSpread	gradientSpread () const
	Returns the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.

Qgis::GradientType	gradientType () const
	Returns the type of gradient, e.g., linear or radial.

QString	layerType () const override
	Returns a string that represents this layer type.

QgsMapUnitScale	mapUnitScale () const override

QPointF	offset () const
	Returns the offset by which polygons will be translated during rendering.

const QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale for the fill's offset.

Qgis::RenderUnit	offsetUnit () const
	Returns the units for the fill's offset.

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.

QPointF	referencePoint1 () const
	Returns the starting point of gradient fill, in the range [0,0] - [1,1].

bool	referencePoint1IsCentroid () const
	Returns whether the starting point for the gradient is taken from the feature centroid.

QPointF	referencePoint2 () const
	Returns the end point of gradient fill, in the range [0,0] - [1,1].

bool	referencePoint2IsCentroid () const
	Returns whether the end point for the gradient is taken from the feature centroid.

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	setColor2 (const QColor &color2)
	Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.

void	setColorRamp (QgsColorRamp *ramp)
	Sets the color ramp used for the gradient fill.

void	setCoordinateMode (Qgis::SymbolCoordinateReference coordinateMode)
	Sets the coordinate mode for gradient, which controls how the gradient stops are positioned.

void	setGradientColorType (Qgis::GradientColorSource gradientColorType)
	Sets the gradient color mode, which controls how gradient color stops are created.

void	setGradientSpread (Qgis::GradientSpread gradientSpread)
	Sets the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.

void	setGradientType (Qgis::GradientType gradientType)
	Sets the type of gradient, e.g., linear or radial.

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOffset (QPointF offset)
	Sets an offset by which polygons will be translated during rendering.

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the fill's offset.

void	setOffsetUnit (Qgis::RenderUnit unit)
	Sets the unit for the fill's offset.

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

void	setReferencePoint1 (QPointF referencePoint)
	Sets the starting point of gradient fill, in the range [0,0] - [1,1].

void	setReferencePoint1IsCentroid (bool isCentroid)
	Sets whether the starting point for the gradient is taken from the feature centroid.

void	setReferencePoint2 (QPointF referencePoint)
	Sets the end point of gradient fill, in the range [0,0] - [1,1].

void	setReferencePoint2IsCentroid (bool isCentroid)
	Sets whether the end point for the gradient is taken from the feature centroid.

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

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

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

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 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 QColor	fillColor () const
	Returns the fill color for the symbol layer.

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 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	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature.

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	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 QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates a new QgsGradientFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

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

Protected Attributes
QBrush	mBrush

QColor	mColor2

Qgis::SymbolCoordinateReference	mCoordinateMode

Qgis::GradientColorSource	mGradientColorType

QgsColorRamp *	mGradientRamp = nullptr

Qgis::GradientSpread	mGradientSpread

Qgis::GradientType	mGradientType

QPointF	mOffset

QgsMapUnitScale	mOffsetMapUnitScale

Qgis::RenderUnit	mOffsetUnit = Qgis::RenderUnit::Millimeters

QPointF	mReferencePoint1

bool	mReferencePoint1IsCentroid = false

QPointF	mReferencePoint2

bool	mReferencePoint2IsCentroid = false

QBrush	mSelBrush

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

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.

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

A fill symbol layer which draws a smooth color gradient over a polygon.

Definition at line 208 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsGradientFillSymbolLayer()

QgsGradientFillSymbolLayer::QgsGradientFillSymbolLayer	(	const QColor &	color = `DEFAULT_SIMPLEFILL_COLOR`,
		const QColor &	color2 = `Qt::white`,
		Qgis::GradientColorSource	gradientColorType = `Qgis::GradientColorSource::SimpleTwoColor`,
		Qgis::GradientType	gradientType = `Qgis::GradientType::Linear`,
		Qgis::SymbolCoordinateReference	coordinateMode = `Qgis::SymbolCoordinateReference::Feature`,
		Qgis::GradientSpread	gradientSpread = `Qgis::GradientSpread::Pad`
	)

Constructor for QgsGradientFillSymbolLayer.

Definition at line 596 of file qgsfillsymbollayer.cpp.

◆ ~QgsGradientFillSymbolLayer()

QgsGradientFillSymbolLayer::~QgsGradientFillSymbolLayer ( )

override

Definition at line 610 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ canCauseArtifactsBetweenAdjacentTiles()

bool QgsGradientFillSymbolLayer::canCauseArtifactsBetweenAdjacentTiles ( ) const

overridevirtual

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 from QgsSymbolLayer.

Definition at line 1076 of file qgsfillsymbollayer.cpp.

◆ clone()

QgsGradientFillSymbolLayer * QgsGradientFillSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 1052 of file qgsfillsymbollayer.cpp.

◆ color2()

QColor QgsGradientFillSymbolLayer::color2 ( ) const

inline

Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.

See also: setColor2()

Definition at line 296 of file qgsfillsymbollayer.h.

◆ colorRamp()

QgsColorRamp * QgsGradientFillSymbolLayer::colorRamp ( )

inline

Returns the color ramp used for the gradient fill.

This is only used if the gradient color type is set to ColorRamp.

See also: setColorRamp(); gradientColorType()

Definition at line 280 of file qgsfillsymbollayer.h.

◆ coordinateMode()

Qgis::SymbolCoordinateReference QgsGradientFillSymbolLayer::coordinateMode ( ) const

inline

Returns the coordinate mode for gradient, which controls how the gradient stops are positioned.

See also: setCoordinateMode()

Definition at line 310 of file qgsfillsymbollayer.h.

◆ create()

QgsSymbolLayer * QgsGradientFillSymbolLayer::create ( const QVariantMap & properties = QVariantMap() )

static

Creates a new QgsGradientFillSymbolLayer using the specified properties map containing symbol properties (see properties()).

Caller takes ownership of the returned symbol layer.

Definition at line 615 of file qgsfillsymbollayer.cpp.

◆ estimateMaxBleed()

double QgsGradientFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext & context ) const

overridevirtual

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 from QgsSymbolLayer.

Definition at line 1070 of file qgsfillsymbollayer.cpp.

◆ flags()

Qgis::SymbolLayerFlags QgsGradientFillSymbolLayer::flags ( ) const

overridevirtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented from QgsSymbolLayer.

Definition at line 699 of file qgsfillsymbollayer.cpp.

◆ gradientColorType()

Qgis::GradientColorSource QgsGradientFillSymbolLayer::gradientColorType ( ) const

inline

Returns the gradient color mode, which controls how gradient color stops are created.

See also: setGradientColorType()

Definition at line 265 of file qgsfillsymbollayer.h.

◆ gradientSpread()

Qgis::GradientSpread QgsGradientFillSymbolLayer::gradientSpread ( ) const

inline

Returns the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.

See also: setGradientSpread()

Definition at line 324 of file qgsfillsymbollayer.h.

◆ gradientType()

Qgis::GradientType QgsGradientFillSymbolLayer::gradientType ( ) const

inline

Returns the type of gradient, e.g., linear or radial.

See also: setGradientType()

Definition at line 251 of file qgsfillsymbollayer.h.

◆ layerType()

QString QgsGradientFillSymbolLayer::layerType ( ) const

overridevirtual

Returns a string that represents this layer type.

Used for serialization. Should match with the string used to register this symbol layer in the registry.

Implements QgsSymbolLayer.

Definition at line 710 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsGradientFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1101 of file qgsfillsymbollayer.cpp.

◆ offset()

QPointF QgsGradientFillSymbolLayer::offset ( ) const

inline

Returns the offset by which polygons will be translated during rendering.

Units are specified by offsetUnit().

See also: setOffset(); offsetUnit()

Definition at line 408 of file qgsfillsymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale & QgsGradientFillSymbolLayer::offsetMapUnitScale ( ) const

inline

Returns the map unit scale for the fill's offset.

See also: offset(); setOffsetMapUnitScale()

Definition at line 436 of file qgsfillsymbollayer.h.

◆ offsetUnit()

Qgis::RenderUnit QgsGradientFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units for the fill's offset.

See also: setOffsetUnit(); offset()

Definition at line 422 of file qgsfillsymbollayer.h.

◆ outputUnit()

Qgis::RenderUnit QgsGradientFillSymbolLayer::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.

Definition at line 1086 of file qgsfillsymbollayer.cpp.

◆ properties()

QVariantMap QgsGradientFillSymbolLayer::properties ( ) const

overridevirtual

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

This is used to serialize a symbol layer perstistently.

Implements QgsSymbolLayer.

Definition at line 1028 of file qgsfillsymbollayer.cpp.

◆ referencePoint1()

QPointF QgsGradientFillSymbolLayer::referencePoint1 ( ) const

inline

Returns the starting point of gradient fill, in the range [0,0] - [1,1].

See also: setReferencePoint1()

Definition at line 345 of file qgsfillsymbollayer.h.

◆ referencePoint1IsCentroid()

bool QgsGradientFillSymbolLayer::referencePoint1IsCentroid ( ) const

inline

Returns whether the starting point for the gradient is taken from the feature centroid.

See also: setReferencePoint1IsCentroid()

Definition at line 359 of file qgsfillsymbollayer.h.

◆ referencePoint2()

QPointF QgsGradientFillSymbolLayer::referencePoint2 ( ) const

inline

Returns the end point of gradient fill, in the range [0,0] - [1,1].

See also: setReferencePoint2()

Definition at line 373 of file qgsfillsymbollayer.h.

◆ referencePoint2IsCentroid()

bool QgsGradientFillSymbolLayer::referencePoint2IsCentroid ( ) const

inline

Returns whether the end point for the gradient is taken from the feature centroid.

See also: setReferencePoint2IsCentroid()

Definition at line 388 of file qgsfillsymbollayer.h.

◆ renderPolygon()

void QgsGradientFillSymbolLayer::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.

Definition at line 988 of file qgsfillsymbollayer.cpp.

◆ setColor2()

void QgsGradientFillSymbolLayer::setColor2 ( const QColor & color2 )

inline

Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.

See also: color2()

Definition at line 303 of file qgsfillsymbollayer.h.

◆ setColorRamp()

void QgsGradientFillSymbolLayer::setColorRamp ( QgsColorRamp * ramp )

Sets the color ramp used for the gradient fill.

This is only used if the gradient color type is set to ColorRamp.

Parameters

ramp	color ramp. Ownership is transferred.

See also: colorRamp(); setGradientColorType()

Definition at line 704 of file qgsfillsymbollayer.cpp.

◆ setCoordinateMode()

void QgsGradientFillSymbolLayer::setCoordinateMode ( Qgis::SymbolCoordinateReference coordinateMode )

inline

Sets the coordinate mode for gradient, which controls how the gradient stops are positioned.

See also: coordinateMode()

Definition at line 317 of file qgsfillsymbollayer.h.

◆ setGradientColorType()

void QgsGradientFillSymbolLayer::setGradientColorType ( Qgis::GradientColorSource gradientColorType )

inline

Sets the gradient color mode, which controls how gradient color stops are created.

See also: gradientColorType()

Definition at line 272 of file qgsfillsymbollayer.h.

◆ setGradientSpread()

void QgsGradientFillSymbolLayer::setGradientSpread ( Qgis::GradientSpread gradientSpread )

inline

Sets the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.

See also: gradientSpread()

Definition at line 331 of file qgsfillsymbollayer.h.

◆ setGradientType()

void QgsGradientFillSymbolLayer::setGradientType ( Qgis::GradientType gradientType )

inline

Sets the type of gradient, e.g., linear or radial.

See also: gradientType()

Definition at line 258 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsGradientFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1096 of file qgsfillsymbollayer.cpp.

◆ setOffset()

void QgsGradientFillSymbolLayer::setOffset ( QPointF offset )

inline

Sets an offset by which polygons will be translated during rendering.

Units are specified by offsetUnit().

See also: offset(); setOffsetUnit()

Definition at line 398 of file qgsfillsymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsGradientFillSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the fill's offset.

See also: setOffset(); offsetMapUnitScale()

Definition at line 429 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

void QgsGradientFillSymbolLayer::setOffsetUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the fill's offset.

See also: offset(); offsetUnit()

Definition at line 415 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsGradientFillSymbolLayer::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.

Definition at line 1081 of file qgsfillsymbollayer.cpp.

◆ setReferencePoint1()

void QgsGradientFillSymbolLayer::setReferencePoint1 ( QPointF referencePoint )

inline

Sets the starting point of gradient fill, in the range [0,0] - [1,1].

See also: referencePoint1()

Definition at line 338 of file qgsfillsymbollayer.h.

◆ setReferencePoint1IsCentroid()

void QgsGradientFillSymbolLayer::setReferencePoint1IsCentroid ( bool isCentroid )

inline

Sets whether the starting point for the gradient is taken from the feature centroid.

See also: referencePoint1IsCentroid()

Definition at line 352 of file qgsfillsymbollayer.h.

◆ setReferencePoint2()

void QgsGradientFillSymbolLayer::setReferencePoint2 ( QPointF referencePoint )

inline

Sets the end point of gradient fill, in the range [0,0] - [1,1].

See also: referencePoint2()

Definition at line 366 of file qgsfillsymbollayer.h.

◆ setReferencePoint2IsCentroid()

void QgsGradientFillSymbolLayer::setReferencePoint2IsCentroid ( bool isCentroid )

inline

Sets whether the end point for the gradient is taken from the feature centroid.

See also: referencePoint2IsCentroid()

Definition at line 380 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsGradientFillSymbolLayer::startRender ( QgsSymbolRenderContext & context )

overridevirtual

Called before a set of rendering operations commences on the supplied render context.

This is always followed by a call to stopRender() after all rendering operations have been completed.

Subclasses can use this method to prepare for a set of rendering operations, e.g. by pre-evaluating paths or images to render, and performing other one-time optimisations.

See also: startFeatureRender(); stopRender()

Implements QgsSymbolLayer.

Definition at line 975 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsGradientFillSymbolLayer::stopRender ( QgsSymbolRenderContext & context )

overridevirtual

Called after a set of rendering operations has finished on the supplied render context.

This is always preceded by a call to startRender() before all rendering operations are commenced.

Subclasses can use this method to cleanup after a set of rendering operations.

See also: startRender(); stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 983 of file qgsfillsymbollayer.cpp.

◆ usesMapUnits()

bool QgsGradientFillSymbolLayer::usesMapUnits ( ) const

overridevirtual

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

Since: QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 1091 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBrush

QBrush QgsGradientFillSymbolLayer::mBrush

protected

Definition at line 446 of file qgsfillsymbollayer.h.

◆ mColor2

QColor QgsGradientFillSymbolLayer::mColor2

protected

Definition at line 450 of file qgsfillsymbollayer.h.

◆ mCoordinateMode

Qgis::SymbolCoordinateReference QgsGradientFillSymbolLayer::mCoordinateMode

protected

Definition at line 453 of file qgsfillsymbollayer.h.

◆ mGradientColorType

Qgis::GradientColorSource QgsGradientFillSymbolLayer::mGradientColorType

protected

Definition at line 449 of file qgsfillsymbollayer.h.

◆ mGradientRamp

QgsColorRamp* QgsGradientFillSymbolLayer::mGradientRamp = nullptr

protected

Definition at line 451 of file qgsfillsymbollayer.h.

◆ mGradientSpread

Qgis::GradientSpread QgsGradientFillSymbolLayer::mGradientSpread

protected

Definition at line 454 of file qgsfillsymbollayer.h.

◆ mGradientType

Qgis::GradientType QgsGradientFillSymbolLayer::mGradientType

protected

Definition at line 452 of file qgsfillsymbollayer.h.

◆ mOffset

QPointF QgsGradientFillSymbolLayer::mOffset

protected

Definition at line 461 of file qgsfillsymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsGradientFillSymbolLayer::mOffsetMapUnitScale

protected

Definition at line 463 of file qgsfillsymbollayer.h.

◆ mOffsetUnit

Qgis::RenderUnit QgsGradientFillSymbolLayer::mOffsetUnit = Qgis::RenderUnit::Millimeters

protected

Definition at line 462 of file qgsfillsymbollayer.h.

◆ mReferencePoint1

QPointF QgsGradientFillSymbolLayer::mReferencePoint1

protected

Definition at line 456 of file qgsfillsymbollayer.h.

◆ mReferencePoint1IsCentroid

bool QgsGradientFillSymbolLayer::mReferencePoint1IsCentroid = false

protected

Definition at line 457 of file qgsfillsymbollayer.h.

◆ mReferencePoint2

QPointF QgsGradientFillSymbolLayer::mReferencePoint2

protected

Definition at line 458 of file qgsfillsymbollayer.h.

◆ mReferencePoint2IsCentroid

bool QgsGradientFillSymbolLayer::mReferencePoint2IsCentroid = false

protected

Definition at line 459 of file qgsfillsymbollayer.h.

◆ mSelBrush

QBrush QgsGradientFillSymbolLayer::mSelBrush

protected

Definition at line 447 of file qgsfillsymbollayer.h.

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

/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.41.0+git20241122+3440c17df1d+99sid/src/core/symbology/qgsfillsymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsGradientFillSymbolLayer()

◆ ~QgsGradientFillSymbolLayer()

Member Function Documentation

◆ canCauseArtifactsBetweenAdjacentTiles()

◆ clone()

◆ color2()

◆ colorRamp()

◆ coordinateMode()

◆ create()

◆ estimateMaxBleed()

◆ flags()

◆ gradientColorType()

◆ gradientSpread()

◆ gradientType()

◆ layerType()

◆ mapUnitScale()

◆ offset()

◆ offsetMapUnitScale()

◆ offsetUnit()

◆ outputUnit()

◆ properties()

◆ referencePoint1()

◆ referencePoint1IsCentroid()

◆ referencePoint2()

◆ referencePoint2IsCentroid()

◆ renderPolygon()

◆ setColor2()

◆ setColorRamp()

◆ setCoordinateMode()

◆ setGradientColorType()

◆ setGradientSpread()

◆ setGradientType()

◆ setMapUnitScale()

◆ setOffset()

◆ setOffsetMapUnitScale()

◆ setOffsetUnit()

◆ setOutputUnit()

◆ setReferencePoint1()

◆ setReferencePoint1IsCentroid()

◆ setReferencePoint2()

◆ setReferencePoint2IsCentroid()

◆ startRender()

◆ stopRender()

◆ usesMapUnits()

Member Data Documentation

◆ mBrush

◆ mColor2

◆ mCoordinateMode

◆ mGradientColorType

◆ mGradientRamp

◆ mGradientSpread

◆ mGradientType

◆ mOffset

◆ mOffsetMapUnitScale

◆ mOffsetUnit

◆ mReferencePoint1

◆ mReferencePoint1IsCentroid

◆ mReferencePoint2

◆ mReferencePoint2IsCentroid

◆ mSelBrush