QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
#include <qgsfillsymbollayer.h>
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... | |
QgsGradientFillSymbolLayer * | clone () 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... | |
QgsColorRamp * | colorRamp () |
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 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 |
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 (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) |
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... | |
![]() | |
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) |
![]() | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
virtual | ~QgsSymbolLayer () |
virtual QColor | color () const |
Returns the "representative" color of the symbol layer. 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 |
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... | |
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... | |
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... | |
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 | 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) |
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 | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. More... | |
virtual QColor | strokeColor () const |
Returns the stroke color for the symbol layer. 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 const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
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 |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
QPointF | mReferencePoint1 |
bool | mReferencePoint1IsCentroid = false |
QPointF | mReferencePoint2 |
bool | mReferencePoint2IsCentroid = false |
QBrush | mSelBrush |
![]() | |
double | mAngle = 0.0 |
![]() | |
QPainterPath | mClipPath |
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 |
Definition at line 211 of file qgsfillsymbollayer.h.
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 526 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 540 of file qgsfillsymbollayer.cpp.
|
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
.
Reimplemented from QgsSymbolLayer.
Definition at line 1004 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 980 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
Definition at line 298 of file qgsfillsymbollayer.h.
|
inline |
Returns the color ramp used for the gradient fill.
This is only used if the gradient color type is set to ColorRamp.
Definition at line 282 of file qgsfillsymbollayer.h.
|
inline |
Returns the coordinate mode for gradient, which controls how the gradient stops are positioned.
Definition at line 312 of file qgsfillsymbollayer.h.
|
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 545 of file qgsfillsymbollayer.cpp.
|
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 998 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the gradient color mode, which controls how gradient color stops are created.
Definition at line 267 of file qgsfillsymbollayer.h.
|
inline |
Returns the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.
Definition at line 326 of file qgsfillsymbollayer.h.
|
inline |
Returns the type of gradient, e.g., linear or radial.
Definition at line 253 of file qgsfillsymbollayer.h.
|
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 635 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 1029 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset by which polygons will be translated during rendering.
Units are specified by offsetUnit().
Definition at line 410 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the fill's offset.
Definition at line 438 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 424 of file qgsfillsymbollayer.h.
|
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.
Reimplemented from QgsSymbolLayer.
Definition at line 1014 of file qgsfillsymbollayer.cpp.
|
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 952 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the starting point of gradient fill, in the range [0,0] - [1,1].
Definition at line 347 of file qgsfillsymbollayer.h.
|
inline |
Returns whether the starting point for the gradient is taken from the feature centroid.
Definition at line 361 of file qgsfillsymbollayer.h.
|
inline |
Returns the end point of gradient fill, in the range [0,0] - [1,1].
Definition at line 375 of file qgsfillsymbollayer.h.
|
inline |
Returns whether the end point for the gradient is taken from the feature centroid.
Definition at line 390 of file qgsfillsymbollayer.h.
|
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 913 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
Definition at line 305 of file qgsfillsymbollayer.h.
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.
ramp | color ramp. Ownership is transferred. |
Definition at line 629 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the coordinate mode for gradient, which controls how the gradient stops are positioned.
Definition at line 319 of file qgsfillsymbollayer.h.
|
inline |
Sets the gradient color mode, which controls how gradient color stops are created.
Definition at line 274 of file qgsfillsymbollayer.h.
|
inline |
Sets the gradient spread mode, which controls how the gradient behaves outside of the predefined stops.
Definition at line 333 of file qgsfillsymbollayer.h.
|
inline |
Sets the type of gradient, e.g., linear or radial.
Definition at line 260 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 1024 of file qgsfillsymbollayer.cpp.
|
inline |
Sets an offset by which polygons will be translated during rendering.
Units are specified by offsetUnit().
Definition at line 400 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the fill's offset.
Definition at line 431 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the fill's offset.
Definition at line 417 of file qgsfillsymbollayer.h.
|
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.
unit | output units |
Reimplemented from QgsSymbolLayer.
Definition at line 1009 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the starting point of gradient fill, in the range [0,0] - [1,1].
Definition at line 340 of file qgsfillsymbollayer.h.
|
inline |
Sets whether the starting point for the gradient is taken from the feature centroid.
Definition at line 354 of file qgsfillsymbollayer.h.
|
inline |
Sets the end point of gradient fill, in the range [0,0] - [1,1].
Definition at line 368 of file qgsfillsymbollayer.h.
|
inline |
Sets whether the end point for the gradient is taken from the feature centroid.
Definition at line 382 of file qgsfillsymbollayer.h.
|
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.
Implements QgsSymbolLayer.
Definition at line 900 of file qgsfillsymbollayer.cpp.
|
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.
Implements QgsSymbolLayer.
Definition at line 908 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 1019 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 448 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 452 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 455 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 451 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 453 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 456 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 454 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 463 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 465 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 464 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 458 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 459 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 460 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 461 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 449 of file qgsfillsymbollayer.h.