QGIS API Documentation  3.37.0-Master (a5b4d9743e8)
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
QgsSVGFillSymbolLayer Class Reference

A class for filling symbols with a repeated SVG file. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsSVGFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsSVGFillSymbolLayer (const QByteArray &svgData, double width=20, double rotation=0.0)
 Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data. More...
 
 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 () override
 
QgsSVGFillSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor dxfColor (QgsSymbolRenderContext &context) const override
 Gets color. 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...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
Qgis::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
QMap< QString, QgsPropertyparameters () const
 Returns the dynamic SVG parameters. More...
 
double patternWidth () const
 Returns the width of the rendered SVG content within the fill (i.e. More...
 
const QgsMapUnitScalepatternWidthMapUnitScale () const
 Returns the map unit scale for the pattern's width. More...
 
Qgis::RenderUnit patternWidthUnit () const
 Returns the units for the width of the SVG images in the pattern. 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 setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setParameters (const QMap< QString, QgsProperty > &parameters)
 Sets the dynamic SVG parameters. 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 (Qgis::RenderUnit unit)
 Sets the unit for the width of the SVG images in the pattern. More...
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol. 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 (Qgis::RenderUnit unit)
 Sets the unit for the stroke width. 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...
 
QgsSymbolsubSymbol () override
 Returns the symbol's sub symbol, if present. More...
 
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 QgsMapUnitScalesvgStrokeWidthMapUnitScale () const
 Returns the map unit scale for the pattern's stroke. More...
 
Qgis::RenderUnit svgStrokeWidthUnit () const
 Returns the units for the stroke width. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD. More...
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns the set of attributes referenced by the layer. 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 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. More...
 
Qt::PenStyle dxfPenStyle () const override
 Gets pen style. More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width. More...
 
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. More...
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 Sets the stroke width map unit scale. More...
 
void setStrokeWidthUnit (Qgis::RenderUnit unit)
 Sets the units for the symbol's stroke width. More...
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 Returns the stroke width map unit scale. More...
 
Qgis::RenderUnit strokeWidthUnit () const
 Returns the units for the symbol's stroke width. More...
 
- Public Member Functions inherited from QgsFillSymbolLayer
 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
 
QgsFillSymbolLayeroperator= (const QgsFillSymbolLayer &other)=delete
 QgsFillSymbolLayer cannot be copied. 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...
 
- Public Member Functions inherited from QgsSymbolLayer
 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 QColor color () const
 Returns the "representative" color of the symbol layer. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () 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 (Qgis::RenderUnit &unit) const
 Gets dash pattern. More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset. More...
 
virtual double dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets marker size. 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...
 
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 QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
QgsPaintEffectpaintEffect () 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 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...
 
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...
 
void setUserFlags (Qgis::SymbolLayerUserFlags flags)
 Sets user-controlled flags which control the symbol layer's behavior. 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...
 
Qgis::SymbolType type () const
 
Qgis::SymbolLayerUserFlags userFlags () const
 Returns user-controlled flags which control the symbol layer's behavior. 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 QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsSVGFillSymbolLayer from a properties map. More...
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 Creates a new QgsSVGFillSymbolLayer from a SLD element. More...
 
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. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Protected Member Functions

void applyDataDefinedSettings (QgsSymbolRenderContext &context) override
 Applies data defined settings prior to generating the fill symbol brush. More...
 
- 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. More...
 
- 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 (Qgis::SymbolType type, bool locked=false)
 Constructor for QgsSymbolLayer. More...
 
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 installMasks (QgsRenderContext &context, bool recursive)
 When rendering, install masks on context painter if recursive is true masks are installed recursively for all children symbol layers. More...
 
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. More...
 
void restoreOldDataDefinedProperties (const QVariantMap &stringMap)
 Restores older data defined properties from string map. More...
 
bool shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
 Returns true if the symbol layer should be rendered using the selection color from the render context. More...
 

Additional Inherited Members

- Public Types inherited from QgsSymbolLayer
enum class  Property : int {
  Size = 0 , Angle , Name , FillColor ,
  StrokeColor , StrokeWidth , StrokeStyle , Offset ,
  Character , Width , Height , PreserveAspectRatio ,
  FillStyle , JoinStyle , SecondaryColor , LineAngle ,
  LineDistance , GradientType , CoordinateMode , GradientSpread ,
  GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y ,
  GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape ,
  ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX ,
  DistanceY , DisplacementX , DisplacementY , Opacity ,
  CustomDash , CapStyle , Placement , Interval ,
  OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor ,
  LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength ,
  ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX ,
  OffsetY , PointCount , RandomSeed , ClipPoints ,
  DensityArea , FontFamily , FontStyle , DashPatternOffset ,
  TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue ,
  LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX ,
  RandomOffsetY , LineClipping
}
 Data definable properties. More...
 
- Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush mBrush
 
Qgis::SymbolCoordinateReference mCoordinateReference = Qgis::SymbolCoordinateReference::Feature
 
double mNextAngle = 0.0
 
double mStrokeWidth = 0.0
 Stroke width. More...
 
QgsMapUnitScale mStrokeWidthMapUnitScale
 
Qgis::RenderUnit mStrokeWidthUnit = Qgis::RenderUnit::Millimeters
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle = 0.0
 
- Protected Attributes inherited from QgsSymbolLayer
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< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 
Qgis::SymbolLayerUserFlags mUserFlags
 User controlled flags. 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...
 

Detailed Description

A class for filling symbols with a repeated SVG file.

Definition at line 1174 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSVGFillSymbolLayer() [1/2]

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 1894 of file qgsfillsymbollayer.cpp.

◆ QgsSVGFillSymbolLayer() [2/2]

QgsSVGFillSymbolLayer::QgsSVGFillSymbolLayer ( const QByteArray &  svgData,
double  width = 20,
double  rotation = 0.0 
)

Constructor for QgsSVGFillSymbolLayer, using the specified SVG picture data.

Definition at line 1904 of file qgsfillsymbollayer.cpp.

◆ ~QgsSVGFillSymbolLayer()

QgsSVGFillSymbolLayer::~QgsSVGFillSymbolLayer ( )
overridedefault

Member Function Documentation

◆ applyDataDefinedSettings()

void QgsSVGFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
overrideprotectedvirtual

Applies data defined settings prior to generating the fill symbol brush.

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2440 of file qgsfillsymbollayer.cpp.

◆ clone()

QgsSVGFillSymbolLayer * QgsSVGFillSymbolLayer::clone ( ) const
overridevirtual

Shall be reimplemented by subclasses to create a deep copy of the instance.

Implements QgsSymbolLayer.

Definition at line 2214 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsSVGFillSymbolLayer::create ( const QVariantMap &  properties = QVariantMap())
static

Creates a new QgsSVGFillSymbolLayer from a properties map.

The caller takes ownership of the returned object.

Definition at line 1965 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsSVGFillSymbolLayer::createFromSld ( QDomElement &  element)
static

Creates a new QgsSVGFillSymbolLayer from a SLD element.

The caller takes ownership of the returned object.

Definition at line 2375 of file qgsfillsymbollayer.cpp.

◆ dxfColor()

QColor QgsSVGFillSymbolLayer::dxfColor ( QgsSymbolRenderContext context) const
overridevirtual

Gets color.

Reimplemented from QgsSymbolLayer.

Definition at line 2348 of file qgsfillsymbollayer.cpp.

◆ estimateMaxBleed()

double QgsSVGFillSymbolLayer::estimateMaxBleed ( const QgsRenderContext context) const
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 2338 of file qgsfillsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsSVGFillSymbolLayer::hasDataDefinedProperties ( ) const
overridevirtual

Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.

Since
QGIS 3.4.5

Reimplemented from QgsSymbolLayer.

Definition at line 2366 of file qgsfillsymbollayer.cpp.

◆ layerType()

QString QgsSVGFillSymbolLayer::layerType ( ) const
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 2085 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSVGFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1945 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsSVGFillSymbolLayer::outputUnit ( ) const
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.

Returns
output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
See also
setOutputUnit()

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1928 of file qgsfillsymbollayer.cpp.

◆ parameters()

QMap<QString, QgsProperty> QgsSVGFillSymbolLayer::parameters ( ) const
inline

Returns the dynamic SVG parameters.

Since
QGIS 3.18

Definition at line 1415 of file qgsfillsymbollayer.h.

◆ patternWidth()

double QgsSVGFillSymbolLayer::patternWidth ( ) const
inline

Returns the width of the rendered SVG content within the fill (i.e.

the pattern repeat/tile size).

Units are retrieved by patternWidthUnit()

See also
setPatternWidth()
patternWidthUnit()
patternWidthMapUnitScale()

Definition at line 1265 of file qgsfillsymbollayer.h.

◆ patternWidthMapUnitScale()

const QgsMapUnitScale& QgsSVGFillSymbolLayer::patternWidthMapUnitScale ( ) const
inline

Returns the map unit scale for the pattern's width.

See also
setPatternWidthMapUnitScale()
patternWidth()
patternWidthUnit()

Definition at line 1367 of file qgsfillsymbollayer.h.

◆ patternWidthUnit()

Qgis::RenderUnit QgsSVGFillSymbolLayer::patternWidthUnit ( ) const
inline

Returns the units for the width of the SVG images in the pattern.

See also
setPatternWidthUnit()
patternWidth()
patternWidthMapUnitScale()

Definition at line 1349 of file qgsfillsymbollayer.h.

◆ properties()

QVariantMap QgsSVGFillSymbolLayer::properties ( ) const
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 2181 of file qgsfillsymbollayer.cpp.

◆ renderPolygon()

void QgsSVGFillSymbolLayer::renderPolygon ( const QPolygonF &  points,
const QVector< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
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 2163 of file qgsfillsymbollayer.cpp.

◆ resolvePaths()

void QgsSVGFillSymbolLayer::resolvePaths ( QVariantMap &  properties,
const QgsPathResolver pathResolver,
bool  saving 
)
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 2073 of file qgsfillsymbollayer.cpp.

◆ setMapUnitScale()

void QgsSVGFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1938 of file qgsfillsymbollayer.cpp.

◆ setOutputUnit()

void QgsSVGFillSymbolLayer::setOutputUnit ( Qgis::RenderUnit  unit)
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.

Parameters
unitoutput units
See also
outputUnit()

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1918 of file qgsfillsymbollayer.cpp.

◆ setParameters()

void QgsSVGFillSymbolLayer::setParameters ( const QMap< QString, QgsProperty > &  parameters)

Sets the dynamic SVG parameters.

Since
QGIS 3.18

Definition at line 2552 of file qgsfillsymbollayer.cpp.

◆ setPatternWidth()

void QgsSVGFillSymbolLayer::setPatternWidth ( double  width)
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()

See also
patternWidth()
setPatternWidthUnit()
setPatternWidthMapUnitScale()

Definition at line 1254 of file qgsfillsymbollayer.h.

◆ setPatternWidthMapUnitScale()

void QgsSVGFillSymbolLayer::setPatternWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the pattern's width.

See also
patternWidthMapUnitScale()
setPatternWidth()
setPatternWidthUnit()

Definition at line 1358 of file qgsfillsymbollayer.h.

◆ setPatternWidthUnit()

void QgsSVGFillSymbolLayer::setPatternWidthUnit ( Qgis::RenderUnit  unit)
inline

Sets the unit for the width of the SVG images in the pattern.

See also
patternWidthUnit()
setPatternWidth()
setPatternWidthMapUnitScale()

Definition at line 1340 of file qgsfillsymbollayer.h.

◆ setSubSymbol()

bool QgsSVGFillSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

Sets layer's subsymbol. takes ownership of the passed symbol.

Reimplemented from QgsSymbolLayer.

Definition at line 2313 of file qgsfillsymbollayer.cpp.

◆ setSvgFilePath()

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

  • relative paths to folders from the user's SVG search paths
  • base64 encoded content, prefixed with a 'base64:' string
  • http(s) paths
See also
svgFilePath()

Definition at line 1956 of file qgsfillsymbollayer.cpp.

◆ setSvgFillColor()

void QgsSVGFillSymbolLayer::setSvgFillColor ( const QColor &  c)
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.

See also
svgFillColor()
setSvgStrokeColor()

Definition at line 1276 of file qgsfillsymbollayer.h.

◆ setSvgStrokeColor()

void QgsSVGFillSymbolLayer::setSvgStrokeColor ( const QColor &  c)
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.

See also
svgStrokeColor()
setSvgFillColor()

Definition at line 1297 of file qgsfillsymbollayer.h.

◆ setSvgStrokeWidth()

void QgsSVGFillSymbolLayer::setSvgStrokeWidth ( double  w)
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()

See also
svgStrokeWidth()
setSvgStrokeWidthUnit()
setSvgStrokeWidthMapUnitScale()

Definition at line 1319 of file qgsfillsymbollayer.h.

◆ setSvgStrokeWidthMapUnitScale()

void QgsSVGFillSymbolLayer::setSvgStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the pattern's stroke.

See also
svgStrokeWidthMapUnitScale()
setSvgStrokeWidth()
setSvgStrokeWidthUnit()

Definition at line 1394 of file qgsfillsymbollayer.h.

◆ setSvgStrokeWidthUnit()

void QgsSVGFillSymbolLayer::setSvgStrokeWidthUnit ( Qgis::RenderUnit  unit)
inline

Sets the unit for the stroke width.

See also
svgStrokeWidthUnit()
setSvgStrokeWidth()
setSvgStrokeWidthMapUnitScale()

Definition at line 1376 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsSVGFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
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.

See also
startFeatureRender()
stopRender()

Implements QgsSymbolLayer.

Definition at line 2143 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsSVGFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
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.

See also
startRender()
stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 2155 of file qgsfillsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsSVGFillSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 2308 of file qgsfillsymbollayer.cpp.

◆ svgFilePath()

QString QgsSVGFillSymbolLayer::svgFilePath ( ) const
inline

Returns the path to the SVG file used to render the fill.

See also
setSvgFilePath()

Definition at line 1243 of file qgsfillsymbollayer.h.

◆ svgFillColor()

QColor QgsSVGFillSymbolLayer::svgFillColor ( ) const
inline

Returns the fill color used for rendering the SVG content.

Fill color is only supported for parametrized SVG files.

See also
setSvgFillColor()
svgStrokeColor()

Definition at line 1286 of file qgsfillsymbollayer.h.

◆ svgStrokeColor()

QColor QgsSVGFillSymbolLayer::svgStrokeColor ( ) const
inline

Returns the stroke color used for rendering the SVG content.

Stroke color is only supported for parametrized SVG files.

See also
setSvgStrokeColor()
svgFillColor()

Definition at line 1307 of file qgsfillsymbollayer.h.

◆ svgStrokeWidth()

double QgsSVGFillSymbolLayer::svgStrokeWidth ( ) const
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()

See also
setSvgStrokeWidth()
svgStrokeWidthUnit()
svgStrokeWidthMapUnitScale()

Definition at line 1331 of file qgsfillsymbollayer.h.

◆ svgStrokeWidthMapUnitScale()

const QgsMapUnitScale& QgsSVGFillSymbolLayer::svgStrokeWidthMapUnitScale ( ) const
inline

Returns the map unit scale for the pattern's stroke.

See also
setSvgStrokeWidthMapUnitScale()
svgStrokeWidth()
svgStrokeWidthUnit()

Definition at line 1403 of file qgsfillsymbollayer.h.

◆ svgStrokeWidthUnit()

Qgis::RenderUnit QgsSVGFillSymbolLayer::svgStrokeWidthUnit ( ) const
inline

Returns the units for the stroke width.

See also
setSvgStrokeWidthUnit()
svgStrokeWidth()
svgStrokeWidthMapUnitScale()

Definition at line 1385 of file qgsfillsymbollayer.h.

◆ toSld()

void QgsSVGFillSymbolLayer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QVariantMap &  props 
) const
overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 2247 of file qgsfillsymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsSVGFillSymbolLayer::usedAttributes ( const QgsRenderContext context) const
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 2358 of file qgsfillsymbollayer.cpp.

◆ usesMapUnits()

bool QgsSVGFillSymbolLayer::usesMapUnits ( ) const
overridevirtual

Returns true if the symbol layer has any components which use map unit based sizes.

Since
QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 2302 of file qgsfillsymbollayer.cpp.


The documentation for this class was generated from the following files: