QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsSimpleFillSymbolLayer (const QColor &color=DEFAULT_SIMPLEFILL_COLOR, Qt::BrushStyle style=DEFAULT_SIMPLEFILL_STYLE, const QColor &strokeColor=DEFAULT_SIMPLEFILL_BORDERCOLOR, Qt::PenStyle strokeStyle=DEFAULT_SIMPLEFILL_BORDERSTYLE, double strokeWidth=DEFAULT_SIMPLEFILL_BORDERWIDTH, Qt::PenJoinStyle penJoinStyle=DEFAULT_SIMPLEFILL_JOINSTYLE) | |
~QgsSimpleFillSymbolLayer () override | |
Qt::BrushStyle | brushStyle () const |
QgsSimpleFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
double | dxfAngle (QgsSymbolRenderContext &context) const override |
Gets angle. More... | |
QColor | dxfBrushColor (QgsSymbolRenderContext &context) const override |
Gets brush/fill color. More... | |
Qt::BrushStyle | dxfBrushStyle () const override |
Gets brush/fill style. More... | |
QColor | dxfColor (QgsSymbolRenderContext &context) const override |
Gets color. More... | |
Qt::PenStyle | dxfPenStyle () const override |
Gets pen style. More... | |
double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets line width. 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... | |
QColor | fillColor () const override |
Returns the fill color for the symbol layer. 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... | |
Qgis::RenderUnit | offsetUnit () const |
Returns the units for the fill's offset. More... | |
QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
Qt::PenJoinStyle | penJoinStyle () const |
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 | setBrushStyle (Qt::BrushStyle style) |
void | setFillColor (const QColor &color) override |
Sets the fill color for the symbol layer. 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 | setPenJoinStyle (Qt::PenJoinStyle style) |
void | setStrokeColor (const QColor &strokeColor) override |
Sets the stroke color for the symbol layer. More... | |
void | setStrokeStyle (Qt::PenStyle strokeStyle) |
void | setStrokeWidth (double strokeWidth) |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setStrokeWidthUnit (Qgis::RenderUnit unit) |
Sets the units for the width of the fill's stroke. 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... | |
QColor | strokeColor () const override |
Returns the stroke color for the symbol layer. More... | |
Qt::PenStyle | strokeStyle () const |
double | strokeWidth () const |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Qgis::RenderUnit | strokeWidthUnit () const |
Returns the units for the width of the fill's stroke. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. More... | |
QImage | toTiledPatternImage () const override |
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... | |
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 |
Returns the rotation angle of the fill symbol, in degrees clockwise. More... | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
QgsFillSymbolLayer & | operator= (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) |
Sets the rotation angle of the pattern, in degrees clockwise. More... | |
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... | |
![]() | |
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 QgsSymbolLayer * | clone () 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... | |
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 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 | dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets marker size. 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< 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... | |
virtual Qgis::RenderUnit | outputUnit () const |
Returns the units to use for sizes and widths within the symbol layer. 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... | |
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 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 | 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 QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
![]() | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Attributes | |
QBrush | mBrush |
Qt::BrushStyle | mBrushStyle |
QPointF | mOffset |
QgsMapUnitScale | mOffsetMapUnitScale |
Qgis::RenderUnit | mOffsetUnit = Qgis::RenderUnit::Millimeters |
QPen | mPen |
Qt::PenJoinStyle | mPenJoinStyle |
QBrush | mSelBrush |
QPen | mSelPen |
QColor | mStrokeColor |
Qt::PenStyle | mStrokeStyle |
double | mStrokeWidth |
QgsMapUnitScale | mStrokeWidthMapUnitScale |
Qgis::RenderUnit | mStrokeWidthUnit = Qgis::RenderUnit::Millimeters |
![]() | |
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 |
QString | mId |
bool | mLocked = false |
std::unique_ptr< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
Qgis::SymbolType | mType |
Definition at line 43 of file qgsfillsymbollayer.h.
QgsSimpleFillSymbolLayer::QgsSimpleFillSymbolLayer | ( | const QColor & | color = DEFAULT_SIMPLEFILL_COLOR , |
Qt::BrushStyle | style = DEFAULT_SIMPLEFILL_STYLE , |
||
const QColor & | strokeColor = DEFAULT_SIMPLEFILL_BORDERCOLOR , |
||
Qt::PenStyle | strokeStyle = DEFAULT_SIMPLEFILL_BORDERSTYLE , |
||
double | strokeWidth = DEFAULT_SIMPLEFILL_BORDERWIDTH , |
||
Qt::PenJoinStyle | penJoinStyle = DEFAULT_SIMPLEFILL_JOINSTYLE |
||
) |
Definition at line 54 of file qgsfillsymbollayer.cpp.
|
overridedefault |
|
inline |
Definition at line 84 of file qgsfillsymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 375 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsSimpleFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
Definition at line 170 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 482 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets angle.
Reimplemented from QgsSymbolLayer.
Definition at line 540 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets brush/fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 556 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets brush/fill style.
Reimplemented from QgsSymbolLayer.
Definition at line 566 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets color.
Reimplemented from QgsSymbolLayer.
Definition at line 529 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets pen style.
Reimplemented from QgsSymbolLayer.
Definition at line 551 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets line width.
Reimplemented from QgsSymbolLayer.
Definition at line 518 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 511 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the fill color for the symbol layer.
This property is not supported by all symbol layer types, only those with a fill component. Symbol layers without a fill component will return an invalid QColor.
Reimplemented from QgsSymbolLayer.
Definition at line 90 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 257 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 95 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset by which polygons will be translated during rendering.
Units are specified by offsetUnit().
Definition at line 120 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the fill's offset.
Definition at line 164 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 150 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 471 of file qgsfillsymbollayer.cpp.
|
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 73 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 99 of file qgsfillsymbollayer.h.
|
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 358 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 292 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 85 of file qgsfillsymbollayer.h.
|
inlineoverridevirtual |
Sets the fill color for the symbol layer.
This property is not supported by all symbol layer types, only those with a fill component.
Reimplemented from QgsSymbolLayer.
Definition at line 91 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 89 of file qgsfillsymbollayer.cpp.
|
inline |
Sets an offset by which polygons will be translated during rendering.
Units are specified by offsetUnit().
Definition at line 110 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the fill's offset.
Definition at line 157 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the fill's offset.
Definition at line 143 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 67 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 100 of file qgsfillsymbollayer.h.
|
inlineoverridevirtual |
Sets the stroke color for the symbol layer.
This property is not supported by all symbol layer types, only those with a stroke component.
Reimplemented from QgsSymbolLayer.
Definition at line 88 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 94 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 97 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 135 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the width of the fill's stroke.
unit | width units |
Definition at line 127 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 262 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 287 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the stroke color for the symbol layer.
This property is not supported by all symbol layer types, only those with a stroke component. Symbol layers without a stroke component will return an invalid QColor.
Reimplemented from QgsSymbolLayer.
Definition at line 87 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 93 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 96 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 136 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the width of the fill's stroke.
Definition at line 133 of file qgsfillsymbollayer.h.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Definition at line 388 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
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.
The default implementation returns a null image.
Reimplemented from QgsFillSymbolLayer.
Definition at line 571 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 83 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 185 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 187 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 197 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 199 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 198 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 194 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 193 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 186 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 195 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 188 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 189 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 190 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 192 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 191 of file qgsfillsymbollayer.h.