QGIS API Documentation  2.99.0-Master (13a3f2f)
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsSVGFillSymbolLayer Class Reference

A class for svg fill patterns. More...

#include <qgsfillsymbollayer.h>

Inheritance diagram for QgsSVGFillSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsSVGFillSymbolLayer (const QString &svgFilePath, double width=20, double rotation=0.0)
 Constructs SVG fill symbol layer with picture from given absolute path to a SVG file. More...
 
 QgsSVGFillSymbolLayer (const QByteArray &svgData, double width=20, double rotation=0.0)
 
 ~QgsSVGFillSymbolLayer ()
 
QgsSVGFillSymbolLayerclone () 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
 
const QgsMapUnitScalepatternWidthMapUnitScale () const
 
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)
 
void setPatternWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setPatternWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the width of the SVG images in the pattern. More...
 
void setSvgFilePath (const QString &svgPath)
 
void setSvgFillColor (const QColor &c)
 
void setSvgStrokeColor (const QColor &c)
 
void setSvgStrokeWidth (double w)
 
void setSvgStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setSvgStrokeWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the stroke width. More...
 
void startRender (QgsSymbolRenderContext &context) override
 
void stopRender (QgsSymbolRenderContext &context) override
 
QString svgFilePath () const
 
QColor svgFillColor () const
 
QColor svgStrokeColor () const
 
double svgStrokeWidth () const
 
const QgsMapUnitScalesvgStrokeWidthMapUnitScale () const
 
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
 get color More...
 
Qt::PenStyle dxfPenStyle () const override
 get pen style More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 get line width More...
 
virtual 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...
 
void renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's stroke width. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol) override
 set layer's subsymbol. takes ownership of the passed symbol More...
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit strokeWidthUnit () const
 Returns the units for the symbol's stroke width. More...
 
virtual QgsSymbolsubSymbol () override
 
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...
 
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
 get angle More...
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 get brush/fill color More...
 
virtual Qt::BrushStyle dxfBrushStyle () const
 get brush/fill style More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
 get dash pattern More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 get offset More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual QColor fillColor () const
 Get 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
 
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...
 
int renderingPass () const
 
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)
 
virtual void setStrokeColor (const QColor &color)
 Set stroke color. More...
 
virtual QColor strokeColor () const
 Get 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 QgsSymbolLayercreate (const QgsStringMap &properties=QgsStringMap())
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 
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 QgsPropertiesDefinitionpropertyDefinitions ()
 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...
 

Protected Attributes

double mPatternWidth
 Width of the pattern (in output units) More...
 
QgsMapUnitScale mPatternWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mPatternWidthUnit
 
QByteArray mSvgData
 SVG data. More...
 
QString mSvgFilePath
 Path to the svg file (or empty if constructed directly from data) More...
 
QImage * mSvgPattern = nullptr
 SVG pattern image. More...
 
QColor mSvgStrokeColor
 
double mSvgStrokeWidth
 
QgsMapUnitScale mSvgStrokeWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mSvgStrokeWidthUnit
 
QRectF mSvgViewBox
 SVG view box (to keep the aspect ratio. More...
 
- Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush mBrush
 
double mNextAngle
 
std::unique_ptr< QgsLineSymbolmStroke
 Custom stroke. More...
 
double mStrokeWidth
 Stroke width. More...
 
QgsMapUnitScale mStrokeWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mStrokeWidthUnit
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle
 
- Protected Attributes inherited from QgsSymbolLayer
QColor mColor
 
QgsPropertyCollection mDataDefinedProperties
 
bool mEnabled
 True if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect = nullptr
 
int mRenderingPass
 
QgsSymbol::SymbolType mType
 

Additional Inherited Members

- Public Types inherited from QgsSymbolLayer
enum  Property {
  PropertySize = 0, PropertyAngle, PropertyName, PropertyFillColor,
  PropertyStrokeColor, PropertyStrokeWidth, PropertyStrokeStyle, PropertyOffset,
  PropertyCharacter, PropertyWidth, PropertyHeight, PropertyFillStyle,
  PropertyJoinStyle, PropertySecondaryColor, PropertyLineAngle, PropertyLineDistance,
  PropertyGradientType, PropertyCoordinateMode, PropertyGradientSpread, PropertyGradientReference1X,
  PropertyGradientReference1Y, PropertyGradientReference2X, PropertyGradientReference2Y, PropertyGradientReference1IsCentroid,
  PropertyGradientReference2IsCentroid, PropertyBlurRadius, PropertyShapeburstUseWholeShape, PropertyShapeburstMaxDistance,
  PropertyShapeburstIgnoreRings, PropertyFile, PropertyDistanceX, PropertyDistanceY,
  PropertyDisplacementX, PropertyDisplacementY, PropertyAlpha, PropertyCustomDash,
  PropertyCapStyle, PropertyPlacement, PropertyInterval, PropertyOffsetAlongLine,
  PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled, PropertyArrowWidth,
  PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness, PropertyArrowHeadType,
  PropertyArrowType
}
 Data definable properties. 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 svg fill patterns.

The class automatically scales the pattern to the appropriate pixel dimensions of the output device

Definition at line 834 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSVGFillSymbolLayer() [1/2]

QgsSVGFillSymbolLayer::QgsSVGFillSymbolLayer ( const QString &  svgFilePath,
double  width = 20,
double  rotation = 0.0 
)

Constructs SVG fill symbol layer with picture from given absolute path to a SVG file.

Definition at line 1718 of file qgsfillsymbollayer.cpp.

◆ QgsSVGFillSymbolLayer() [2/2]

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

Definition at line 1734 of file qgsfillsymbollayer.cpp.

◆ ~QgsSVGFillSymbolLayer()

QgsSVGFillSymbolLayer::~QgsSVGFillSymbolLayer ( )

Definition at line 1752 of file qgsfillsymbollayer.cpp.

Member Function Documentation

◆ applyDataDefinedSettings()

void QgsSVGFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
overrideprotectedvirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2179 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 2028 of file qgsfillsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsSVGFillSymbolLayer::create ( const QgsStringMap properties = QgsStringMap())
static

Definition at line 1804 of file qgsfillsymbollayer.cpp.

◆ createFromSld()

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

Definition at line 2114 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 1918 of file qgsfillsymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSVGFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1784 of file qgsfillsymbollayer.cpp.

◆ outputUnit()

QgsUnitTypes::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 1766 of file qgsfillsymbollayer.cpp.

◆ patternWidth()

double QgsSVGFillSymbolLayer::patternWidth ( ) const
inline

Definition at line 869 of file qgsfillsymbollayer.h.

◆ patternWidthMapUnitScale()

const QgsMapUnitScale& QgsSVGFillSymbolLayer::patternWidthMapUnitScale ( ) const
inline

Definition at line 891 of file qgsfillsymbollayer.h.

◆ patternWidthUnit()

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

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

See also
setPatternWidthUnit()

Definition at line 888 of file qgsfillsymbollayer.h.

◆ properties()

QgsStringMap 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.

Implements QgsSymbolLayer.

Definition at line 1998 of file qgsfillsymbollayer.cpp.

◆ resolvePaths()

void QgsSVGFillSymbolLayer::resolvePaths ( QgsStringMap 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.

Since
QGIS 3.0

Definition at line 1906 of file qgsfillsymbollayer.cpp.

◆ setMapUnitScale()

void QgsSVGFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1776 of file qgsfillsymbollayer.cpp.

◆ setOutputUnit()

void QgsSVGFillSymbolLayer::setOutputUnit ( QgsUnitTypes::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 1757 of file qgsfillsymbollayer.cpp.

◆ setPatternWidth()

void QgsSVGFillSymbolLayer::setPatternWidth ( double  width)
inline

Definition at line 868 of file qgsfillsymbollayer.h.

◆ setPatternWidthMapUnitScale()

void QgsSVGFillSymbolLayer::setPatternWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 890 of file qgsfillsymbollayer.h.

◆ setPatternWidthUnit()

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

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

Parameters
unitwidth units
See also
patternWidthUnit()

Definition at line 883 of file qgsfillsymbollayer.h.

◆ setSvgFilePath()

void QgsSVGFillSymbolLayer::setSvgFilePath ( const QString &  svgPath)

Definition at line 1795 of file qgsfillsymbollayer.cpp.

◆ setSvgFillColor()

void QgsSVGFillSymbolLayer::setSvgFillColor ( const QColor &  c)
inline

Definition at line 871 of file qgsfillsymbollayer.h.

◆ setSvgStrokeColor()

void QgsSVGFillSymbolLayer::setSvgStrokeColor ( const QColor &  c)
inline

Definition at line 874 of file qgsfillsymbollayer.h.

◆ setSvgStrokeWidth()

void QgsSVGFillSymbolLayer::setSvgStrokeWidth ( double  w)
inline

Definition at line 876 of file qgsfillsymbollayer.h.

◆ setSvgStrokeWidthMapUnitScale()

void QgsSVGFillSymbolLayer::setSvgStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 904 of file qgsfillsymbollayer.h.

◆ setSvgStrokeWidthUnit()

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

Sets the units for the stroke width.

Parameters
unitwidth units
See also
svgStrokeWidthUnit()

Definition at line 897 of file qgsfillsymbollayer.h.

◆ startRender()

void QgsSVGFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 1979 of file qgsfillsymbollayer.cpp.

◆ stopRender()

void QgsSVGFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 1990 of file qgsfillsymbollayer.cpp.

◆ svgFilePath()

QString QgsSVGFillSymbolLayer::svgFilePath ( ) const
inline

Definition at line 867 of file qgsfillsymbollayer.h.

◆ svgFillColor()

QColor QgsSVGFillSymbolLayer::svgFillColor ( ) const
inline

Definition at line 872 of file qgsfillsymbollayer.h.

◆ svgStrokeColor()

QColor QgsSVGFillSymbolLayer::svgStrokeColor ( ) const
inline

Definition at line 875 of file qgsfillsymbollayer.h.

◆ svgStrokeWidth()

double QgsSVGFillSymbolLayer::svgStrokeWidth ( ) const
inline

Definition at line 877 of file qgsfillsymbollayer.h.

◆ svgStrokeWidthMapUnitScale()

const QgsMapUnitScale& QgsSVGFillSymbolLayer::svgStrokeWidthMapUnitScale ( ) const
inline

Definition at line 905 of file qgsfillsymbollayer.h.

◆ svgStrokeWidthUnit()

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

Returns the units for the stroke width.

See also
setSvgStrokeWidthUnit()

Definition at line 902 of file qgsfillsymbollayer.h.

◆ toSld()

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

Reimplemented from QgsSymbolLayer.

Definition at line 2059 of file qgsfillsymbollayer.cpp.

Member Data Documentation

◆ mPatternWidth

double QgsSVGFillSymbolLayer::mPatternWidth
protected

Width of the pattern (in output units)

Definition at line 915 of file qgsfillsymbollayer.h.

◆ mPatternWidthMapUnitScale

QgsMapUnitScale QgsSVGFillSymbolLayer::mPatternWidthMapUnitScale
protected

Definition at line 917 of file qgsfillsymbollayer.h.

◆ mPatternWidthUnit

QgsUnitTypes::RenderUnit QgsSVGFillSymbolLayer::mPatternWidthUnit
protected

Definition at line 916 of file qgsfillsymbollayer.h.

◆ mSvgData

QByteArray QgsSVGFillSymbolLayer::mSvgData
protected

SVG data.

Definition at line 920 of file qgsfillsymbollayer.h.

◆ mSvgFilePath

QString QgsSVGFillSymbolLayer::mSvgFilePath
protected

Path to the svg file (or empty if constructed directly from data)

Definition at line 922 of file qgsfillsymbollayer.h.

◆ mSvgPattern

QImage* QgsSVGFillSymbolLayer::mSvgPattern = nullptr
protected

SVG pattern image.

Definition at line 926 of file qgsfillsymbollayer.h.

◆ mSvgStrokeColor

QColor QgsSVGFillSymbolLayer::mSvgStrokeColor
protected

Definition at line 930 of file qgsfillsymbollayer.h.

◆ mSvgStrokeWidth

double QgsSVGFillSymbolLayer::mSvgStrokeWidth
protected

Definition at line 931 of file qgsfillsymbollayer.h.

◆ mSvgStrokeWidthMapUnitScale

QgsMapUnitScale QgsSVGFillSymbolLayer::mSvgStrokeWidthMapUnitScale
protected

Definition at line 933 of file qgsfillsymbollayer.h.

◆ mSvgStrokeWidthUnit

QgsUnitTypes::RenderUnit QgsSVGFillSymbolLayer::mSvgStrokeWidthUnit
protected

Definition at line 932 of file qgsfillsymbollayer.h.

◆ mSvgViewBox

QRectF QgsSVGFillSymbolLayer::mSvgViewBox
protected

SVG view box (to keep the aspect ratio.

Definition at line 924 of file qgsfillsymbollayer.h.


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