QGIS API Documentation
3.26.3-Buenos Aires (65e4edfdad)
|
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsShapeburstFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, const QColor &color2=Qt::white, Qgis::GradientColorSource colorType=Qgis::GradientColorSource::SimpleTwoColor, int blurRadius=0, bool useWholeShape=true, double maxDistance=5) | |
Constructor for QgsShapeburstFillSymbolLayer. More... | |
QgsShapeburstFillSymbolLayer (const QgsShapeburstFillSymbolLayer &other)=delete | |
QgsShapeburstFillSymbolLayer cannot be copied. More... | |
~QgsShapeburstFillSymbolLayer () override | |
int | blurRadius () const |
Returns the blur radius, which controls the amount of blurring applied to the fill. More... | |
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... | |
QgsShapeburstFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QColor | color2 () const |
Returns the color used for the endpoint of the shapeburst fill. More... | |
QgsColorRamp * | colorRamp () |
Returns the color ramp used for the shapeburst fill. More... | |
Qgis::GradientColorSource | colorType () const |
Returns the color mode used for the shapeburst fill. More... | |
const QgsMapUnitScale & | distanceMapUnitScale () const |
QgsUnitTypes::RenderUnit | distanceUnit () const |
Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary. 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... | |
bool | ignoreRings () const |
Returns whether the shapeburst fill is set to ignore polygon interior rings. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
double | maxDistance () const |
Returns the maximum distance from the shape's boundary which is shaded. More... | |
QPointF | offset () const |
Returns the offset for the shapeburst fill. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units used for the offset of the shapeburst fill. More... | |
QgsShapeburstFillSymbolLayer & | operator= (const QgsShapeburstFillSymbolLayer &other)=delete |
QgsShapeburstFillSymbolLayer cannot be copied. 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... | |
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 | setBlurRadius (int blurRadius) |
Sets the blur radius, which controls the amount of blurring applied to the fill. More... | |
void | setColor2 (const QColor &color2) |
Sets the color for the endpoint of the shapeburst fill. More... | |
void | setColorRamp (QgsColorRamp *ramp) |
Sets the color ramp used to draw the shapeburst fill. More... | |
void | setColorType (Qgis::GradientColorSource colorType) |
Sets the color mode to use for the shapeburst fill. More... | |
void | setDistanceMapUnitScale (const QgsMapUnitScale &scale) |
void | setDistanceUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary. More... | |
void | setIgnoreRings (bool ignoreRings) |
Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setMaxDistance (double maxDistance) |
Sets the maximum distance to shape inside of the shape from the polygon's boundary. More... | |
void | setOffset (QPointF offset) |
Sets the offset for the shapeburst fill. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
void | setOffsetUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units used for the offset for the shapeburst fill. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setUseWholeShape (bool useWholeShape) |
Sets whether the shapeburst fill should be drawn using the entire shape. 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... | |
bool | useWholeShape () const |
Returns whether the shapeburst fill is set to cover the entire shape. 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 QgsShapeburstFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More... | |
![]() | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Definition at line 486 of file qgsfillsymbollayer.h.
QgsShapeburstFillSymbolLayer::QgsShapeburstFillSymbolLayer | ( | const QColor & | color = DEFAULT_SIMPLEFILL_COLOR , |
const QColor & | color2 = Qt::white , |
||
Qgis::GradientColorSource | colorType = Qgis::GradientColorSource::SimpleTwoColor , |
||
int | blurRadius = 0 , |
||
bool | useWholeShape = true , |
||
double | maxDistance = 5 |
||
) |
Constructor for QgsShapeburstFillSymbolLayer.
Definition at line 1036 of file qgsfillsymbollayer.cpp.
|
overridedefault |
|
delete |
QgsShapeburstFillSymbolLayer cannot be copied.
|
inline |
Returns the blur radius, which controls the amount of blurring applied to the fill.
Definition at line 545 of file qgsfillsymbollayer.h.
|
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 1662 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 1638 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the color used for the endpoint of the shapeburst fill.
This color is only used if the colorType is set to ShapeburstColorType::SimpleTwoColor
Definition at line 667 of file qgsfillsymbollayer.h.
|
inline |
Returns the color ramp used for the shapeburst fill.
The color ramp is only used if the colorType is set to ShapeburstColorType::ColorRamp
Definition at line 649 of file qgsfillsymbollayer.h.
|
inline |
Returns the color mode used for the shapeburst fill.
Shapeburst can either be drawn using a QgsColorRamp color ramp or by simply specificing a start and end color.
Definition at line 629 of file qgsfillsymbollayer.h.
|
static |
Creates a new QgsShapeburstFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
Definition at line 1049 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 605 of file qgsfillsymbollayer.h.
|
inline |
Returns the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
Definition at line 602 of file qgsfillsymbollayer.h.
|
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 1656 of file qgsfillsymbollayer.cpp.
|
inline |
Returns whether the shapeburst fill is set to ignore polygon interior rings.
true
if the shapeburst fill will ignore interior rings when calculating buffered shading. Definition at line 684 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 1144 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 1694 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the maximum distance from the shape's boundary which is shaded.
This parameter is only effective if useWholeShape is false
.
Definition at line 584 of file qgsfillsymbollayer.h.
|
inline |
Returns the offset for the shapeburst fill.
Definition at line 702 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 723 of file qgsfillsymbollayer.h.
|
inline |
Returns the units used for the offset of the shapeburst fill.
Definition at line 720 of file qgsfillsymbollayer.h.
|
delete |
QgsShapeburstFillSymbolLayer cannot be copied.
|
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 1673 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 1611 of file qgsfillsymbollayer.cpp.
|
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 1224 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the blur radius, which controls the amount of blurring applied to the fill.
blurRadius | Radius for fill blur. Values between 0 - 17 are valid, where higher values results in a stronger blur. Set to 0 to disable blur. |
Definition at line 537 of file qgsfillsymbollayer.h.
|
inline |
Sets the color for the endpoint of the shapeburst fill.
This color is only used if setColorType is set ShapeburstColorType::SimpleTwoColor.
color2 | QColor to use for endpoint of gradient |
Definition at line 658 of file qgsfillsymbollayer.h.
void QgsShapeburstFillSymbolLayer::setColorRamp | ( | QgsColorRamp * | ramp | ) |
Sets the color ramp used to draw the shapeburst fill.
Color ramps are only used if setColorType is set ShapeburstColorType::ColorRamp.
Ownership of ramp is transferred to the fill.
Definition at line 1149 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the color mode to use for the shapeburst fill.
Shapeburst can either be drawn using a QgsColorRamp color ramp or by simply specificing a start and end color. setColorType is used to specify which mode to use for the fill.
colorType | color type to use for shapeburst fill |
Definition at line 617 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 604 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the maximum distance to shade inside of the shape from the polygon's boundary.
unit | distance unit for the maximum distance |
Definition at line 593 of file qgsfillsymbollayer.h.
|
inline |
Sets whether the shapeburst fill should ignore polygon rings when calculating the buffered shading.
ignoreRings | Set to true if buffers should ignore interior rings for polygons. |
Definition at line 676 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 1688 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the maximum distance to shape inside of the shape from the polygon's boundary.
maxDistance | distance from boundary to shade. setUseWholeShape must be set to false for this parameter to take effect. Distance unit is controlled by setDistanceUnit. |
Definition at line 574 of file qgsfillsymbollayer.h.
|
inline |
Sets the offset for the shapeburst fill.
offset | QPointF indicating the horizontal/vertical offset amount |
Definition at line 693 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 722 of file qgsfillsymbollayer.h.
|
inline |
Sets the units used for the offset for the shapeburst fill.
unit | units for fill offset |
Definition at line 711 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 1667 of file qgsfillsymbollayer.cpp.
|
inline |
Sets whether the shapeburst fill should be drawn using the entire shape.
useWholeShape | Set to true if shapeburst should cover entire shape. If false , setMaxDistance is used to calculate how far from the boundary of the shape should be shaded |
Definition at line 555 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 1210 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 1219 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 1682 of file qgsfillsymbollayer.cpp.
|
inline |
Returns whether the shapeburst fill is set to cover the entire shape.
true
if shapeburst fill will cover the entire shape. If false
, shapeburst is drawn to a distance of maxDistance from the polygon's boundary. Definition at line 564 of file qgsfillsymbollayer.h.