QGIS API Documentation 3.30.0-'s-Hertogenbosch (f186b8efe0)
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
QgsGradientFillSymbolLayer Class Reference

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsGradientFillSymbolLayer:
Inheritance graph
[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. More...
 
 ~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...
 
QgsGradientFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor color2 () const
 Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor. More...
 
QgsColorRampcolorRamp ()
 Returns the color ramp used for the gradient fill. More...
 
Qgis::SymbolCoordinateReference coordinateMode () const
 Returns the coordinate mode for gradient, which 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...
 
Qgis::GradientColorSource gradientColorType () const
 Returns the gradient color mode, which controls how gradient color stops are created. More...
 
Qgis::GradientSpread gradientSpread () const
 Returns the gradient spread mode, which controls how the gradient behaves outside of the predefined stops. More...
 
Qgis::GradientType gradientType () const
 Returns the 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 QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the fill's offset. More...
 
Qgis::RenderUnit offsetUnit () const
 Returns the units for the fill's offset. More...
 
Qgis::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
 Returns the starting point of gradient fill, in the range [0,0] - [1,1]. More...
 
bool referencePoint1IsCentroid () const
 Returns whether the starting point for the gradient is taken from the feature centroid. More...
 
QPointF referencePoint2 () const
 Returns the end point of gradient fill, in the range [0,0] - [1,1]. More...
 
bool referencePoint2IsCentroid () const
 Returns whether the end point for the gradient is taken from the feature centroid. More...
 
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)
 Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor. More...
 
void setColorRamp (QgsColorRamp *ramp)
 Sets the color ramp used for the gradient fill. More...
 
void setCoordinateMode (Qgis::SymbolCoordinateReference coordinateMode)
 Sets the coordinate mode for gradient, which controls how the gradient stops are positioned. More...
 
void setGradientColorType (Qgis::GradientColorSource gradientColorType)
 Sets the gradient color mode, which controls how gradient color stops are created. More...
 
void setGradientSpread (Qgis::GradientSpread gradientSpread)
 Sets the gradient spread mode, which controls how the gradient behaves outside of the predefined stops. More...
 
void setGradientType (Qgis::GradientType gradientType)
 Sets the type of gradient, e.g., linear or radial. More...
 
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 (Qgis::RenderUnit unit)
 Sets the unit for the fill's offset. More...
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setReferencePoint1 (QPointF referencePoint)
 Sets the starting point of gradient fill, in the range [0,0] - [1,1]. More...
 
void setReferencePoint1IsCentroid (bool isCentroid)
 Sets whether the starting point for the gradient is taken from the feature centroid. More...
 
void setReferencePoint2 (QPointF referencePoint)
 Sets the end point of gradient fill, in the range [0,0] - [1,1]. More...
 
void setReferencePoint2IsCentroid (bool isCentroid)
 Sets whether the end point for the gradient is taken from 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
 
QgsFillSymbolLayeroperator= (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. More...
 
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. More...
 
void setAngle (double angle)
 
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. More...
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual ~QgsSymbolLayer ()
 
virtual bool canCauseArtifactsBetweenAdjacentTiles () const
 Returns true if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry. More...
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 Returns the "representative" color of the symbol layer. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
virtual void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 Gets angle. More...
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 Gets brush/fill color. More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 Gets brush/fill style. More...
 
virtual QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color. More...
 
virtual QVector< qreal > dxfCustomDashPattern (Qgis::RenderUnit &unit) const
 Gets dash pattern. More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset. More...
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style. More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets line width. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual double estimateMaxBleed (const QgsRenderContext &context) const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More...
 
virtual QColor fillColor () const
 Returns the fill color for the symbol layer. More...
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior. More...
 
virtual bool hasDataDefinedProperties () const
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More...
 
QString id () const
 Returns symbol layer identifier This id is unique in the whole project. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More...
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual Qgis::RenderUnit outputUnit () const
 Returns the units to use for sizes and widths within the symbol layer. More...
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer. More...
 
virtual void prepareExpressions (const QgsSymbolRenderContext &context)
 Prepares all data defined property expressions for evaluation. More...
 
virtual 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. More...
 
virtual QVariantMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setColor (const QColor &color)
 Sets the "representative" color for the symbol layer. 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)
 Sets the fill color for the symbol layer. More...
 
void setId (const QString &id)
 Set symbol layer identifier This id has to be unique in the whole project. More...
 
void setLocked (bool locked)
 Sets whether the layer's colors are locked. More...
 
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. 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)
 Sets the stroke color for the symbol layer. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
virtual void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called before the layer will be rendered for a particular feature. More...
 
virtual void startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context. More...
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool usesMapUnits () const
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
 write as DXF More...
 

Static Public Member Functions

static QgsSymbolLayercreate (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 QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Protected Attributes

QBrush mBrush
 
QColor mColor2
 
Qgis::SymbolCoordinateReference mCoordinateMode
 
Qgis::GradientColorSource mGradientColorType
 
QgsColorRampmGradientRamp = 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. More...
 
QgsFields mFields
 
QString mId
 
bool mLocked = false
 
std::unique_ptr< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 

Additional Inherited Members

- 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 , PropertyLineStartWidthValue , PropertyLineEndWidthValue ,
  PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX ,
  PropertyRandomOffsetY , PropertyLineClipping
}
 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. 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 installMasks (QgsRenderContext &context, bool recursive)
 When rendering, install masks on context painter if recursive is true masks are installed recursively for all children symbol layers. More...
 
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. 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 213 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 594 of file qgsfillsymbollayer.cpp.

◆ ~QgsGradientFillSymbolLayer()

QgsGradientFillSymbolLayer::~QgsGradientFillSymbolLayer ( )
override

Definition at line 608 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 1072 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 1048 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 300 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 284 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 314 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 613 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 1066 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 269 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 328 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 255 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 703 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsGradientFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1097 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 412 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 440 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 426 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 1082 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 1020 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 349 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 363 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 377 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 392 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 981 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 307 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
rampcolor ramp. Ownership is transferred.
See also
colorRamp()
setGradientColorType()

Definition at line 697 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 321 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 276 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 335 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 262 of file qgsfillsymbollayer.h.

◆ setMapUnitScale()

void QgsGradientFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 1092 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 402 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 433 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 419 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
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 1077 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 342 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 356 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 370 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 384 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 968 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 976 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 1087 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mBrush

QBrush QgsGradientFillSymbolLayer::mBrush
protected

Definition at line 450 of file qgsfillsymbollayer.h.

◆ mColor2

QColor QgsGradientFillSymbolLayer::mColor2
protected

Definition at line 454 of file qgsfillsymbollayer.h.

◆ mCoordinateMode

Qgis::SymbolCoordinateReference QgsGradientFillSymbolLayer::mCoordinateMode
protected

Definition at line 457 of file qgsfillsymbollayer.h.

◆ mGradientColorType

Qgis::GradientColorSource QgsGradientFillSymbolLayer::mGradientColorType
protected

Definition at line 453 of file qgsfillsymbollayer.h.

◆ mGradientRamp

QgsColorRamp* QgsGradientFillSymbolLayer::mGradientRamp = nullptr
protected

Definition at line 455 of file qgsfillsymbollayer.h.

◆ mGradientSpread

Qgis::GradientSpread QgsGradientFillSymbolLayer::mGradientSpread
protected

Definition at line 458 of file qgsfillsymbollayer.h.

◆ mGradientType

Qgis::GradientType QgsGradientFillSymbolLayer::mGradientType
protected

Definition at line 456 of file qgsfillsymbollayer.h.

◆ mOffset

QPointF QgsGradientFillSymbolLayer::mOffset
protected

Definition at line 465 of file qgsfillsymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsGradientFillSymbolLayer::mOffsetMapUnitScale
protected

Definition at line 467 of file qgsfillsymbollayer.h.

◆ mOffsetUnit

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

Definition at line 466 of file qgsfillsymbollayer.h.

◆ mReferencePoint1

QPointF QgsGradientFillSymbolLayer::mReferencePoint1
protected

Definition at line 460 of file qgsfillsymbollayer.h.

◆ mReferencePoint1IsCentroid

bool QgsGradientFillSymbolLayer::mReferencePoint1IsCentroid = false
protected

Definition at line 461 of file qgsfillsymbollayer.h.

◆ mReferencePoint2

QPointF QgsGradientFillSymbolLayer::mReferencePoint2
protected

Definition at line 462 of file qgsfillsymbollayer.h.

◆ mReferencePoint2IsCentroid

bool QgsGradientFillSymbolLayer::mReferencePoint2IsCentroid = false
protected

Definition at line 463 of file qgsfillsymbollayer.h.

◆ mSelBrush

QBrush QgsGradientFillSymbolLayer::mSelBrush
protected

Definition at line 451 of file qgsfillsymbollayer.h.


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