QGIS API Documentation
3.8.0-Zanzibar (11aff65)
|
A class for filling symbols with a repeated SVG file. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsSVGFillSymbolLayer (const QString &svgFilePath, double width=20, double rotation=0.0) | |
Constructor for QgsSVGFillSymbolLayer, using the SVG picture at the specified absolute file path. More... | |
QgsSVGFillSymbolLayer (const QByteArray &svgData, double width=20, double rotation=0.0) | |
Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data. More... | |
QgsSVGFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
double | patternWidth () const |
Returns the width of the rendered SVG content within the fill (i.e. More... | |
const QgsMapUnitScale & | patternWidthMapUnitScale () const |
Returns the map unit scale for the pattern's width. More... | |
QgsUnitTypes::RenderUnit | patternWidthUnit () const |
Returns the units for the width of the SVG images in the pattern. More... | |
QgsStringMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setPatternWidth (double width) |
Sets the width to render the SVG content as within the fill (i.e. More... | |
void | setPatternWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's width. More... | |
void | setPatternWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the width of the SVG images in the pattern. More... | |
void | setSvgFilePath (const QString &svgPath) |
Sets the path to the SVG file to render in the fill. More... | |
void | setSvgFillColor (const QColor &c) |
Sets the fill color used for rendering the SVG content. More... | |
void | setSvgStrokeColor (const QColor &c) |
Sets the stroke color used for rendering the SVG content. More... | |
void | setSvgStrokeWidth (double w) |
Sets the stroke width used for rendering the SVG content. More... | |
void | setSvgStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's stroke. More... | |
void | setSvgStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the stroke width. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
void | stopRender (QgsSymbolRenderContext &context) override |
QString | svgFilePath () const |
Returns the path to the SVG file used to render the fill. More... | |
QColor | svgFillColor () const |
Returns the fill color used for rendering the SVG content. More... | |
QColor | svgStrokeColor () const |
Returns the stroke color used for rendering the SVG content. More... | |
double | svgStrokeWidth () const |
Returns the stroke width used for rendering the SVG content. More... | |
const QgsMapUnitScale & | svgStrokeWidthMapUnitScale () const |
Returns the map unit scale for the pattern's stroke. More... | |
QgsUnitTypes::RenderUnit | svgStrokeWidthUnit () const |
Returns the units for the stroke width. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
Public Member Functions inherited from QgsImageFillSymbolLayer | |
QgsImageFillSymbolLayer () | |
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... | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
void | renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the stroke width map unit scale. More... | |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units fo the symbol's stroke width. More... | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Returns the stroke width map unit scale. More... | |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. More... | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. More... | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. More... | |
Public Member Functions inherited from QgsFillSymbolLayer | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
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 QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
Gets dash pattern. More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. 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 | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. More... | |
bool | isLocked () const |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
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 QColor | strokeColor () const |
Gets stroke color. More... | |
QgsSymbol::SymbolType | type () const |
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 QgsStringMap &properties=QgsStringMap()) |
Creates a new QgsSVGFillSymbolLayer from a properties map. More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsSVGFillSymbolLayer from a SLD element. More... | |
static void | resolvePaths (QgsStringMap &properties, const QgsPathResolver &pathResolver, bool saving) |
Turns relative paths in properties map to absolute when reading and vice versa when writing. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
Protected Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QList< 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 QgsStringMap &stringMap) |
Restores older data defined properties from string map. More... | |
A class for filling symbols with a repeated SVG file.
Definition at line 933 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 1735 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 1745 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2175 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2026 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsSVGFillSymbolLayer from a properties map.
The caller takes ownership of the returned object.
Definition at line 1805 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsSVGFillSymbolLayer from a SLD element.
The caller takes ownership of the returned object.
Definition at line 2112 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 1919 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 1785 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 1767 of file qgsfillsymbollayer.cpp.
|
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 1014 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's width.
Definition at line 1116 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the width of the SVG images in the pattern.
Definition at line 1098 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 1996 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 1907 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 1777 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 1758 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 1003 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's width.
Definition at line 1107 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the width of the SVG images in the pattern.
Definition at line 1089 of file qgsfillsymbollayer.h.
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 1796 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 1025 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 1046 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 1068 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's stroke.
Definition at line 1143 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the stroke width.
Definition at line 1125 of file qgsfillsymbollayer.h.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 1977 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 1988 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the path to the SVG file used to render the fill.
Definition at line 992 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 1035 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 1056 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 1080 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's stroke.
Definition at line 1152 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the stroke width.
Definition at line 1134 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 2057 of file qgsfillsymbollayer.cpp.