QGIS API Documentation
3.18.1-Zürich (202f1bf7e5)
|
#include <qgsfillsymbollayer.h>
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 |
virtual QgsSymbolLayerReferenceList | 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) |
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... | |
QgsSymbol::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 |
QgsSymbol::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 (QgsSymbol::SymbolType type, bool locked=false) | |
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... | |
Definition at line 205 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
SimpleTwoColor | |
ColorRamp |
Definition at line 209 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Feature | |
Viewport |
Definition at line 222 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Pad | |
Reflect | |
Repeat |
Definition at line 228 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Linear | |
Radial | |
Conical |
Definition at line 215 of file qgsfillsymbollayer.h.
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 513 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 527 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 991 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 967 of file qgsfillsymbollayer.cpp.
|
inline |
Color for endpoint of gradient, only used if the gradient color type is set to SimpleTwoColor.
Definition at line 291 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 279 of file qgsfillsymbollayer.h.
|
inline |
Coordinate mode for gradient. Controls how the gradient stops are positioned.
Definition at line 295 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 532 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 985 of file qgsfillsymbollayer.cpp.
|
inline |
Gradient color mode, controls how gradient color stops are created.
Definition at line 270 of file qgsfillsymbollayer.h.
|
inline |
Gradient spread mode. Controls how the gradient behaves outside of the predefined stops.
Definition at line 299 of file qgsfillsymbollayer.h.
|
inline |
Type of gradient, e.g., linear or radial.
Definition at line 266 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 622 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 1016 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset by which polygons will be translated during rendering.
Units are specified by offsetUnit().
Definition at line 336 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the fill's offset.
Definition at line 364 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 350 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 1001 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 939 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 304 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 308 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 312 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 316 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 900 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 292 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 616 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 296 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 271 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 300 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 267 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 1011 of file qgsfillsymbollayer.cpp.
|
inline |
Sets an offset by which polygons will be translated during rendering.
Units are specified by offsetUnit().
Definition at line 326 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the fill's offset.
Definition at line 357 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the fill's offset.
Definition at line 343 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 996 of file qgsfillsymbollayer.cpp.
|
inline |
Starting point of gradient fill, in the range [0,0] - [1,1].
Definition at line 303 of file qgsfillsymbollayer.h.
|
inline |
Sets the starting point of the gradient to be the feature centroid.
Definition at line 307 of file qgsfillsymbollayer.h.
|
inline |
End point of gradient fill, in the range [0,0] - [1,1].
Definition at line 311 of file qgsfillsymbollayer.h.
|
inline |
Sets the end point of the gradient to be the feature centroid.
Definition at line 315 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 887 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 895 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 1006 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 374 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 378 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 381 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 377 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 379 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 382 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 380 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 389 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 391 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 390 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 384 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 385 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 386 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 387 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 375 of file qgsfillsymbollayer.h.