QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A class for filling symbols with a repeated SVG file. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsSVGFillSymbolLayer (const QByteArray &svgData, double width=20, double rotation=0.0) | |
Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data. | |
QgsSVGFillSymbolLayer (const QString &svgFilePath, double width=20, double rotation=0.0) | |
Constructor for QgsSVGFillSymbolLayer, using the SVG picture at the specified absolute file path. | |
~QgsSVGFillSymbolLayer () override | |
QgsSVGFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. | |
QColor | dxfColor (QgsSymbolRenderContext &context) const override |
Gets color. | |
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. | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. | |
QString | layerType () const override |
Returns a string that represents this layer type. | |
QgsMapUnitScale | mapUnitScale () const override |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. | |
QMap< QString, QgsProperty > | parameters () const |
Returns the dynamic SVG parameters. | |
double | patternWidth () const |
Returns the width of the rendered SVG content within the fill (i.e. | |
const QgsMapUnitScale & | patternWidthMapUnitScale () const |
Returns the map unit scale for the pattern's width. | |
Qgis::RenderUnit | patternWidthUnit () const |
Returns the units for the width of the SVG images in the pattern. | |
QVariantMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. | |
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. | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (Qgis::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. | |
void | setParameters (const QMap< QString, QgsProperty > ¶meters) |
Sets the dynamic SVG parameters. | |
void | setPatternWidth (double width) |
Sets the width to render the SVG content as within the fill (i.e. | |
void | setPatternWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's width. | |
void | setPatternWidthUnit (Qgis::RenderUnit unit) |
Sets the unit for the width of the SVG images in the pattern. | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. | |
void | setSvgFilePath (const QString &svgPath) |
Sets the path to the SVG file to render in the fill. | |
void | setSvgFillColor (const QColor &c) |
Sets the fill color used for rendering the SVG content. | |
void | setSvgStrokeColor (const QColor &c) |
Sets the stroke color used for rendering the SVG content. | |
void | setSvgStrokeWidth (double w) |
Sets the stroke width used for rendering the SVG content. | |
void | setSvgStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's stroke. | |
void | setSvgStrokeWidthUnit (Qgis::RenderUnit unit) |
Sets the unit for the stroke width. | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. | |
QString | svgFilePath () const |
Returns the path to the SVG file used to render the fill. | |
QColor | svgFillColor () const |
Returns the fill color used for rendering the SVG content. | |
QColor | svgStrokeColor () const |
Returns the stroke color used for rendering the SVG content. | |
double | svgStrokeWidth () const |
Returns the stroke width used for rendering the SVG content. | |
const QgsMapUnitScale & | svgStrokeWidthMapUnitScale () const |
Returns the map unit scale for the pattern's stroke. | |
Qgis::RenderUnit | svgStrokeWidthUnit () const |
Returns the units for the stroke width. | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. | |
Public Member Functions inherited from QgsImageFillSymbolLayer | |
QgsImageFillSymbolLayer () | |
~QgsImageFillSymbolLayer () override | |
Qgis::SymbolCoordinateReference | coordinateReference () const |
Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. | |
Qt::PenStyle | dxfPenStyle () const override |
Gets pen style. | |
double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets line width. | |
void | setCoordinateReference (Qgis::SymbolCoordinateReference coordinateReference) |
Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. | |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the stroke width map unit scale. | |
void | setStrokeWidthUnit (Qgis::RenderUnit unit) |
Sets the units for the symbol's stroke width. | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Returns the stroke width map unit scale. | |
Qgis::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. | |
Public Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete | |
double | angle () const |
Returns the rotation angle of the fill symbol, in degrees clockwise. | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
QgsFillSymbolLayer & | operator= (const QgsFillSymbolLayer &other)=delete |
void | setAngle (double angle) |
Sets the rotation angle of the pattern, in degrees clockwise. | |
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. | |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
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. | |
virtual QColor | color () const |
Returns the "representative" color of the symbol layer. | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. | |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const |
Gets angle. | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
Gets brush/fill color. | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
Gets brush/fill style. | |
virtual QVector< qreal > | dxfCustomDashPattern (Qgis::RenderUnit &unit) const |
Gets dash pattern. | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. | |
virtual double | dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets marker size. | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. | |
virtual QColor | fillColor () const |
Returns the fill color for the symbol layer. | |
virtual Qgis::SymbolLayerFlags | flags () const |
Returns flags which control the symbol layer's behavior. | |
QString | id () const |
Returns symbol layer identifier This id is unique in the whole project. | |
bool | installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF()) |
When rendering, install masks on context painter. | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. | |
bool | isLocked () const |
Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. | |
virtual QList< QgsSymbolLayerReference > | masks () const |
Returns masks defined by this symbol layer. | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. | |
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. | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. | |
virtual void | setColor (const QColor &color) |
Sets the "representative" color for the symbol layer. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. | |
virtual void | setFillColor (const QColor &color) |
Sets the fill color for the symbol layer. | |
void | setId (const QString &id) |
Set symbol layer identifier This id has to be unique in the whole project. | |
void | setLocked (bool locked) |
Sets whether the layer's colors are locked. | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. | |
void | setRenderingPass (int renderingPass) |
Specifies the rendering pass in which this symbol layer should be rendered. | |
virtual void | setStrokeColor (const QColor &color) |
Sets the stroke color for the symbol layer. | |
void | setUserFlags (Qgis::SymbolLayerUserFlags flags) |
Sets user-controlled flags which control the symbol layer's behavior. | |
virtual void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called before the layer will be rendered for a particular feature. | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. | |
virtual QColor | strokeColor () const |
Returns the stroke color for the symbol layer. | |
Qgis::SymbolType | type () const |
Qgis::SymbolLayerUserFlags | userFlags () const |
Returns user-controlled flags which control the symbol layer's behavior. | |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF | |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates a new QgsSVGFillSymbolLayer from a properties map. | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsSVGFillSymbolLayer from a SLD element. | |
static void | resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving) |
Turns relative paths in properties map to absolute when reading and vice versa when writing. | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. | |
Protected Member Functions | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
Applies data defined settings prior to generating the fill symbol brush. | |
Protected Member Functions inherited from QgsImageFillSymbolLayer | |
virtual bool | applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const |
Returns true if the image brush should be transformed using the render context's texture origin. | |
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. | |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (Qgis::SymbolType type, bool locked=false) | |
Constructor for QgsSymbolLayer. | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. | |
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. | |
void | restoreOldDataDefinedProperties (const QVariantMap &stringMap) |
Restores older data defined properties from string map. | |
bool | shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const |
Returns true if the symbol layer should be rendered using the selection color from the render context. | |
A class for filling symbols with a repeated SVG file.
Definition at line 1172 of file qgsfillsymbollayer.h.
QgsSVGFillSymbolLayer::QgsSVGFillSymbolLayer | ( | const QString & | svgFilePath, |
double | width = 20 , |
||
double | rotation = 0.0 |
||
) |
Constructor for QgsSVGFillSymbolLayer, using the SVG picture at the specified absolute file path.
Definition at line 1909 of file qgsfillsymbollayer.cpp.
QgsSVGFillSymbolLayer::QgsSVGFillSymbolLayer | ( | const QByteArray & | svgData, |
double | width = 20 , |
||
double | rotation = 0.0 |
||
) |
Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data.
Definition at line 1919 of file qgsfillsymbollayer.cpp.
|
overridedefault |
|
overrideprotectedvirtual |
Applies data defined settings prior to generating the fill symbol brush.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2456 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2230 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsSVGFillSymbolLayer from a properties map.
The caller takes ownership of the returned object.
Definition at line 1980 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsSVGFillSymbolLayer from a SLD element.
The caller takes ownership of the returned object.
Definition at line 2391 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Gets color.
Reimplemented from QgsSymbolLayer.
Definition at line 2364 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 2354 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsSymbolLayer.
Definition at line 2382 of file qgsfillsymbollayer.cpp.
|
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 2100 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 1960 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 QgsImageFillSymbolLayer.
Definition at line 1943 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the dynamic SVG parameters.
Definition at line 1413 of file qgsfillsymbollayer.h.
|
inline |
Returns the width of the rendered SVG content within the fill (i.e.
the pattern repeat/tile size).
Units are retrieved by patternWidthUnit()
Definition at line 1263 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's width.
Definition at line 1365 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the width of the SVG images in the pattern.
Definition at line 1347 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.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2197 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.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2179 of file qgsfillsymbollayer.cpp.
|
static |
Turns relative paths in properties map to absolute when reading and vice versa when writing.
Used internally when reading/writing symbols.
Definition at line 2088 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 1953 of file qgsfillsymbollayer.cpp.
|
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 QgsImageFillSymbolLayer.
Definition at line 1933 of file qgsfillsymbollayer.cpp.
void QgsSVGFillSymbolLayer::setParameters | ( | const QMap< QString, QgsProperty > & | parameters | ) |
Sets the dynamic SVG parameters.
Definition at line 2568 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the width to render the SVG content as within the fill (i.e.
the pattern repeat/tile size).
Units are specified by setPatternWidthUnit()
Definition at line 1252 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's width.
Definition at line 1356 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the width of the SVG images in the pattern.
Definition at line 1338 of file qgsfillsymbollayer.h.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 2329 of file qgsfillsymbollayer.cpp.
void QgsSVGFillSymbolLayer::setSvgFilePath | ( | const QString & | svgPath | ) |
Sets the path to the SVG file to render in the fill.
This is usually an absolute file path. Other supported options include
Definition at line 1971 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the fill color used for rendering the SVG content.
Fill color is only supported for parametrized SVG files. Color opacity is ignored if the SVG file does not support parametrized fill opacity.
Definition at line 1274 of file qgsfillsymbollayer.h.
|
inline |
Sets the stroke color used for rendering the SVG content.
Stroke color is only supported for parametrized SVG files. Color opacity is ignored if the SVG file does not support parametrized outline opacity.
Definition at line 1295 of file qgsfillsymbollayer.h.
|
inline |
Sets the stroke width used for rendering the SVG content.
Stroke width is only supported for parametrized SVG files. Units are specified via setSvgStrokeWidthUnit()
Definition at line 1317 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's stroke.
Definition at line 1392 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the stroke width.
Definition at line 1374 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 2158 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 2171 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 2324 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the path to the SVG file used to render the fill.
Definition at line 1241 of file qgsfillsymbollayer.h.
|
inline |
Returns the fill color used for rendering the SVG content.
Fill color is only supported for parametrized SVG files.
Definition at line 1284 of file qgsfillsymbollayer.h.
|
inline |
Returns the stroke color used for rendering the SVG content.
Stroke color is only supported for parametrized SVG files.
Definition at line 1305 of file qgsfillsymbollayer.h.
|
inline |
Returns the stroke width used for rendering the SVG content.
Stroke width is only supported for parametrized SVG files. Units are retrieved via setSvgStrokeWidthUnit()
Definition at line 1329 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's stroke.
Definition at line 1401 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the stroke width.
Definition at line 1383 of file qgsfillsymbollayer.h.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Definition at line 2263 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the set of attributes referenced by the layer.
This includes attributes required by any data defined properties associated with the layer.
Reimplemented from QgsSymbolLayer.
Definition at line 2374 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 2318 of file qgsfillsymbollayer.cpp.