#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsGradientFillSymbolLayer:

Public Types
enum	GradientColorType { SimpleTwoColor , ColorRamp }

enum	GradientCoordinateMode { Feature , Viewport }

enum	GradientSpread { Pad , Reflect , Repeat }

enum	GradientType { Linear , Radial , Conical }

Public Types inherited from QgsSymbolLayer
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 }
	Data definable properties. More...

Public Member Functions
	QgsGradientFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, GradientColorType gradientColorType=SimpleTwoColor, GradientType gradientType=Linear, GradientCoordinateMode coordinateMode=Feature, GradientSpread gradientSpread=Pad)

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

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

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

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

GradientCoordinateMode	coordinateMode () const
	Coordinate mode for gradient. Controls how the gradient stops are positioned. More...

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

GradientColorType	gradientColorType () const
	Gradient color mode, controls how gradient color stops are created. More...

GradientSpread	gradientSpread () const
	Gradient spread mode. Controls how the gradient behaves outside of the predefined stops. More...

GradientType	gradientType () const
	Type of gradient, e.g., linear or radial. More...

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

QgsMapUnitScale	mapUnitScale () const override

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

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

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

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

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

QPointF	referencePoint1 () const

bool	referencePoint1IsCentroid () const

QPointF	referencePoint2 () const

bool	referencePoint2IsCentroid () const

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

void	setColor2 (const QColor &color2)

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

void	setCoordinateMode (GradientCoordinateMode coordinateMode)

void	setGradientColorType (GradientColorType gradientColorType)

void	setGradientSpread (GradientSpread gradientSpread)

void	setGradientType (GradientType gradientType)

void	setMapUnitScale (const QgsMapUnitScale &scale) override

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

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

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

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

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

void	setReferencePoint1IsCentroid (bool isCentroid)
	Sets the starting point of the gradient to be the feature centroid. More...

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

void	setReferencePoint2IsCentroid (bool isCentroid)
	Sets the end point of the gradient to be the feature centroid. More...

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

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

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

Public Member Functions inherited from QgsFillSymbolLayer
	QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete
	QgsFillSymbolLayer cannot be copied. More...

double	angle () const

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

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

void	setAngle (double angle)

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

virtual	~QgsSymbolLayer ()

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 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 QColor	fillColor () const
	Gets fill color. 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 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...

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

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

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	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature. 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	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 QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates a new QgsGradientFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More...

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

Protected Attributes
QBrush	mBrush

QColor	mColor2

GradientCoordinateMode	mCoordinateMode

GradientColorType	mGradientColorType

QgsColorRamp *	mGradientRamp = nullptr

GradientSpread	mGradientSpread

GradientType	mGradientType

QPointF	mOffset

QgsMapUnitScale	mOffsetMapUnitScale

QgsUnitTypes::RenderUnit	mOffsetUnit = QgsUnitTypes::RenderMillimeters

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

Additional Inherited Members
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. More...

Protected Member Functions inherited from QgsSymbolLayer
	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...

Static Protected Attributes inherited from QgsSymbolLayer
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 211 of file qgsfillsymbollayer.h.

Member Enumeration Documentation

◆ GradientColorType

enum QgsGradientFillSymbolLayer::GradientColorType

Enumerator
SimpleTwoColor
ColorRamp

Definition at line 215 of file qgsfillsymbollayer.h.

◆ GradientCoordinateMode

enum QgsGradientFillSymbolLayer::GradientCoordinateMode

Enumerator
Feature
Viewport

Definition at line 228 of file qgsfillsymbollayer.h.

◆ GradientSpread

enum QgsGradientFillSymbolLayer::GradientSpread

Enumerator
Pad
Reflect
Repeat

Definition at line 234 of file qgsfillsymbollayer.h.

◆ GradientType

enum QgsGradientFillSymbolLayer::GradientType

Enumerator
Linear
Radial
Conical

Definition at line 221 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsGradientFillSymbolLayer()

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

Definition at line 521 of file qgsfillsymbollayer.cpp.

◆ ~QgsGradientFillSymbolLayer()

QgsGradientFillSymbolLayer::~QgsGradientFillSymbolLayer ( )

override

Definition at line 535 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 999 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 975 of file qgsfillsymbollayer.cpp.

◆ color2()

QColor QgsGradientFillSymbolLayer::color2 ( ) const

inline

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

Definition at line 297 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 285 of file qgsfillsymbollayer.h.

◆ coordinateMode()

GradientCoordinateMode QgsGradientFillSymbolLayer::coordinateMode ( ) const

inline

Coordinate mode for gradient. Controls how the gradient stops are positioned.

Definition at line 301 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 540 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 993 of file qgsfillsymbollayer.cpp.

◆ gradientColorType()

GradientColorType QgsGradientFillSymbolLayer::gradientColorType ( ) const

inline

Gradient color mode, controls how gradient color stops are created.

Definition at line 276 of file qgsfillsymbollayer.h.

◆ gradientSpread()

GradientSpread QgsGradientFillSymbolLayer::gradientSpread ( ) const

inline

Gradient spread mode. Controls how the gradient behaves outside of the predefined stops.

Definition at line 305 of file qgsfillsymbollayer.h.

◆ gradientType()

GradientType QgsGradientFillSymbolLayer::gradientType ( ) const

inline

Type of gradient, e.g., linear or radial.

Definition at line 272 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 630 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsGradientFillSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1024 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 342 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 370 of file qgsfillsymbollayer.h.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsGradientFillSymbolLayer::offsetUnit ( ) const

inline

Returns the units for the fill's offset.

See also: setOffsetUnit(); offset()

Definition at line 356 of file qgsfillsymbollayer.h.

◆ outputUnit()

QgsUnitTypes::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 1009 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 947 of file qgsfillsymbollayer.cpp.

◆ referencePoint1()

QPointF QgsGradientFillSymbolLayer::referencePoint1 ( ) const

inline

Definition at line 310 of file qgsfillsymbollayer.h.

◆ referencePoint1IsCentroid()

bool QgsGradientFillSymbolLayer::referencePoint1IsCentroid ( ) const

inline

Definition at line 314 of file qgsfillsymbollayer.h.

◆ referencePoint2()

QPointF QgsGradientFillSymbolLayer::referencePoint2 ( ) const

inline

Definition at line 318 of file qgsfillsymbollayer.h.

◆ referencePoint2IsCentroid()

bool QgsGradientFillSymbolLayer::referencePoint2IsCentroid ( ) const

inline

Definition at line 322 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 908 of file qgsfillsymbollayer.cpp.

◆ setColor2()

void QgsGradientFillSymbolLayer::setColor2 ( const QColor & color2 )

inline

Definition at line 298 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 624 of file qgsfillsymbollayer.cpp.

◆ setCoordinateMode()

void QgsGradientFillSymbolLayer::setCoordinateMode ( GradientCoordinateMode coordinateMode )

inline

Definition at line 302 of file qgsfillsymbollayer.h.

◆ setGradientColorType()

void QgsGradientFillSymbolLayer::setGradientColorType ( GradientColorType gradientColorType )

inline

Definition at line 277 of file qgsfillsymbollayer.h.

◆ setGradientSpread()

void QgsGradientFillSymbolLayer::setGradientSpread ( GradientSpread gradientSpread )

inline

Definition at line 306 of file qgsfillsymbollayer.h.

◆ setGradientType()

void QgsGradientFillSymbolLayer::setGradientType ( GradientType gradientType )

inline

Definition at line 273 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsGradientFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1019 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 332 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 363 of file qgsfillsymbollayer.h.

◆ setOffsetUnit()

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

inline

Sets the unit for the fill's offset.

See also: offset(); offsetUnit()

Definition at line 349 of file qgsfillsymbollayer.h.

◆ setOutputUnit()

void QgsGradientFillSymbolLayer::setOutputUnit ( QgsUnitTypes::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 1004 of file qgsfillsymbollayer.cpp.

◆ setReferencePoint1()

void QgsGradientFillSymbolLayer::setReferencePoint1 ( QPointF referencePoint )

inline

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

Definition at line 309 of file qgsfillsymbollayer.h.

◆ setReferencePoint1IsCentroid()

void QgsGradientFillSymbolLayer::setReferencePoint1IsCentroid ( bool isCentroid )

inline

Sets the starting point of the gradient to be the feature centroid.

Definition at line 313 of file qgsfillsymbollayer.h.

◆ setReferencePoint2()

void QgsGradientFillSymbolLayer::setReferencePoint2 ( QPointF referencePoint )

inline

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

Definition at line 317 of file qgsfillsymbollayer.h.

◆ setReferencePoint2IsCentroid()

void QgsGradientFillSymbolLayer::setReferencePoint2IsCentroid ( bool isCentroid )

inline

Sets the end point of the gradient to be the feature centroid.

Definition at line 321 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 895 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 903 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 1014 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBrush

QBrush QgsGradientFillSymbolLayer::mBrush

protected

Definition at line 380 of file qgsfillsymbollayer.h.

◆ mColor2

QColor QgsGradientFillSymbolLayer::mColor2

protected

Definition at line 384 of file qgsfillsymbollayer.h.

◆ mCoordinateMode

GradientCoordinateMode QgsGradientFillSymbolLayer::mCoordinateMode

protected

Definition at line 387 of file qgsfillsymbollayer.h.

◆ mGradientColorType

GradientColorType QgsGradientFillSymbolLayer::mGradientColorType

protected

Definition at line 383 of file qgsfillsymbollayer.h.

◆ mGradientRamp

QgsColorRamp* QgsGradientFillSymbolLayer::mGradientRamp = nullptr

protected

Definition at line 385 of file qgsfillsymbollayer.h.

◆ mGradientSpread

GradientSpread QgsGradientFillSymbolLayer::mGradientSpread

protected

Definition at line 388 of file qgsfillsymbollayer.h.

◆ mGradientType

GradientType QgsGradientFillSymbolLayer::mGradientType

protected

Definition at line 386 of file qgsfillsymbollayer.h.

◆ mOffset

QPointF QgsGradientFillSymbolLayer::mOffset

protected

Definition at line 395 of file qgsfillsymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsGradientFillSymbolLayer::mOffsetMapUnitScale

protected

Definition at line 397 of file qgsfillsymbollayer.h.

◆ mOffsetUnit

QgsUnitTypes::RenderUnit QgsGradientFillSymbolLayer::mOffsetUnit = QgsUnitTypes::RenderMillimeters

protected

Definition at line 396 of file qgsfillsymbollayer.h.

◆ mReferencePoint1

QPointF QgsGradientFillSymbolLayer::mReferencePoint1

protected

Definition at line 390 of file qgsfillsymbollayer.h.

◆ mReferencePoint1IsCentroid

bool QgsGradientFillSymbolLayer::mReferencePoint1IsCentroid = false

protected

Definition at line 391 of file qgsfillsymbollayer.h.

◆ mReferencePoint2

QPointF QgsGradientFillSymbolLayer::mReferencePoint2

protected

Definition at line 392 of file qgsfillsymbollayer.h.

◆ mReferencePoint2IsCentroid

bool QgsGradientFillSymbolLayer::mReferencePoint2IsCentroid = false

protected

Definition at line 393 of file qgsfillsymbollayer.h.

◆ mSelBrush

QBrush QgsGradientFillSymbolLayer::mSelBrush

protected

Definition at line 381 of file qgsfillsymbollayer.h.

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

/build/qgis-3.20.0+99unstable/src/core/symbology/qgsfillsymbollayer.h
/build/qgis-3.20.0+99unstable/src/core/symbology/qgsfillsymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ GradientColorType

◆ GradientCoordinateMode

◆ GradientSpread

◆ GradientType

Constructor & Destructor Documentation

◆ QgsGradientFillSymbolLayer()

◆ ~QgsGradientFillSymbolLayer()

Member Function Documentation

◆ canCauseArtifactsBetweenAdjacentTiles()

◆ clone()

◆ color2()

◆ colorRamp()

◆ coordinateMode()

◆ create()

◆ estimateMaxBleed()

◆ 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