QGIS API Documentation  2.99.0-Master (c558d51)
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)
 
 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 setSvgOutlineColor (const QColor &c)
 
void setSvgOutlineWidth (double w)
 
void setSvgOutlineWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setSvgOutlineWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the outline width. More...
 
void startRender (QgsSymbolRenderContext &context) override
 
void stopRender (QgsSymbolRenderContext &context) override
 
QString svgFilePath () const
 
QColor svgFillColor () const
 
QColor svgOutlineColor () const
 
double svgOutlineWidth () const
 
const QgsMapUnitScalesvgOutlineWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit svgOutlineWidthUnit () const
 Returns the units for the outline width. More...
 
void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override
 
- Public Member Functions inherited from QgsImageFillSymbolLayer
 QgsImageFillSymbolLayer ()
 
virtual ~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 override
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape. More...
 
const QgsMapUnitScaleoutlineWidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit outlineWidthUnit () const
 Returns the units for the symbol's outline width. More...
 
void renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override
 
void setOutlineWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setOutlineWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the symbol's outline width. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol) override
 set layer's subsymbol. takes ownership of the passed symbol More...
 
virtual QgsSymbolsubSymbol () override
 
QSet< QString > usedAttributes () 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...
 
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 QVariant evaluateDataDefinedProperty (const QString &property, const QgsSymbolRenderContext &context, const QVariant &defaultVal=QVariant(), bool *ok=nullptr) const
 Evaluates the matching data defined property and returns the calculated value. More...
 
virtual QColor fillColor () const
 Get fill color. More...
 
virtual QgsDataDefinedgetDataDefinedProperty (const QString &property) const
 Returns the data defined property corresponding to the specified property key. More...
 
virtual bool hasDataDefinedProperties () const
 Checks whether the layer has any associated data defined properties. More...
 
virtual bool hasDataDefinedProperty (const QString &property) const
 Checks whether the layer has a matching data defined property and if that property is currently actived. 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
 
virtual QColor outlineColor () const
 Get outline color. 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 removeDataDefinedProperties ()
 Removes all data defined properties from the layer and deletes associated objects. More...
 
virtual void removeDataDefinedProperty (const QString &property)
 Removes a data defined property from the layer. More...
 
int renderingPass () const
 
virtual void setColor (const QColor &color)
 The fill color. More...
 
virtual void setDataDefinedProperty (const QString &property, QgsDataDefined *dataDefined)
 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)
 
virtual void setOutlineColor (const QColor &color)
 Set outline color. More...
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer. More...
 
void setRenderingPass (int renderingPass)
 
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)
 

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 restoreDataDefinedProperties (const QgsStringMap &stringMap)
 Restores all data defined properties from string map. More...
 
void saveDataDefinedProperties (QgsStringMap &stringMap) const
 Saves all data defined properties to a 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...
 
QColor mSvgOutlineColor
 
double mSvgOutlineWidth
 
QgsMapUnitScale mSvgOutlineWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mSvgOutlineWidthUnit
 
QImage * mSvgPattern
 SVG pattern image. More...
 
QRectF mSvgViewBox
 SVG view box (to keep the aspect ratio. More...
 
- Protected Attributes inherited from QgsImageFillSymbolLayer
QBrush mBrush
 
double mNextAngle
 
QgsLineSymbolmOutline
 Custom outline. More...
 
double mOutlineWidth
 Outline width. More...
 
QgsMapUnitScale mOutlineWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mOutlineWidthUnit
 
- Protected Attributes inherited from QgsFillSymbolLayer
double mAngle
 
- Protected Attributes inherited from QgsSymbolLayer
QColor mColor
 
QMap< QString, QgsDataDefined * > mDataDefinedProperties
 
bool mEnabled
 True if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect
 
int mRenderingPass
 
QgsSymbol::SymbolType mType
 

Additional Inherited Members

- Static Public Attributes inherited from QgsSymbolLayer
static const QString EXPR_LAYER_ENABLED
 Data defined layer enabled string. More...
 
- Static Protected Attributes inherited from QgsSymbolLayer
static const QString EXPR_ALPHA
 
static const QString EXPR_ANGLE
 
static const QString EXPR_BLUR_RADIUS
 
static const QString EXPR_BORDER_COLOR
 
static const QString EXPR_BORDER_STYLE
 
static const QString EXPR_CAPSTYLE
 
static const QString EXPR_CHAR
 
static const QString EXPR_COLOR
 
static const QString EXPR_COLOR2
 
static const QString EXPR_COLOR_BORDER
 
static const QString EXPR_COORDINATE_MODE
 
static const QString EXPR_CUSTOMDASH
 
static const QString EXPR_DISPLACEMENT_X
 
static const QString EXPR_DISPLACEMENT_Y
 
static const QString EXPR_DISTANCE
 
static const QString EXPR_DISTANCE_X
 
static const QString EXPR_DISTANCE_Y
 
static const QString EXPR_FILE
 
static const QString EXPR_FILL
 
static const QString EXPR_FILL_COLOR
 
static const QString EXPR_FILL_STYLE
 
static const QString EXPR_GRADIENT_TYPE
 
static const QString EXPR_HEIGHT
 
static const QString EXPR_HORIZONTAL_ANCHOR_POINT
 
static const QString EXPR_IGNORE_RINGS
 
static const QString EXPR_INTERVAL
 
static const QString EXPR_JOIN_STYLE
 
static const QString EXPR_JOINSTYLE
 
static const QString EXPR_LINE_STYLE
 
static const QString EXPR_LINEANGLE
 
static const QString EXPR_LINEWIDTH
 
static const QString EXPR_MAX_DISTANCE
 
static const QString EXPR_NAME
 
static const QString EXPR_OFFSET
 
static const QString EXPR_OFFSET_ALONG_LINE
 
static const QString EXPR_OUTLINE
 
static const QString EXPR_OUTLINE_COLOR
 
static const QString EXPR_OUTLINE_STYLE
 
static const QString EXPR_OUTLINE_WIDTH
 
static const QString EXPR_PLACEMENT
 
static const QString EXPR_REFERENCE1_ISCENTROID
 
static const QString EXPR_REFERENCE1_X
 
static const QString EXPR_REFERENCE1_Y
 
static const QString EXPR_REFERENCE2_ISCENTROID
 
static const QString EXPR_REFERENCE2_X
 
static const QString EXPR_REFERENCE2_Y
 
static const QString EXPR_ROTATION
 
static const QString EXPR_SIZE
 
static const QString EXPR_SPREAD
 
static const QString EXPR_SVG_FILE
 
static const QString EXPR_SVG_FILL_COLOR
 
static const QString EXPR_SVG_OUTLINE_COLOR
 
static const QString EXPR_SVG_OUTLINE_WIDTH
 
static const QString EXPR_SYMBOL_NAME
 
static const QString EXPR_USE_WHOLE_SHAPE
 
static const QString EXPR_VERTICAL_ANCHOR_POINT
 
static const QString EXPR_WIDTH
 
static const QString EXPR_WIDTH_BORDER
 
static const bool selectFillBorder = false
 
static const bool selectFillStyle = false
 
static const bool selectionIsOpaque = true
 

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 836 of file qgsfillsymbollayer.h.

Constructor & Destructor Documentation

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

Definition at line 1749 of file qgsfillsymbollayer.cpp.

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

Definition at line 1765 of file qgsfillsymbollayer.cpp.

QgsSVGFillSymbolLayer::~QgsSVGFillSymbolLayer ( )

Definition at line 1783 of file qgsfillsymbollayer.cpp.

Member Function Documentation

void QgsSVGFillSymbolLayer::applyDataDefinedSettings ( QgsSymbolRenderContext context)
overrideprotectedvirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 2198 of file qgsfillsymbollayer.cpp.

QgsSVGFillSymbolLayer * QgsSVGFillSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 2052 of file qgsfillsymbollayer.cpp.

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

Definition at line 1835 of file qgsfillsymbollayer.cpp.

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

Definition at line 2138 of file qgsfillsymbollayer.cpp.

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

QgsMapUnitScale QgsSVGFillSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1815 of file qgsfillsymbollayer.cpp.

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, eg 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 1797 of file qgsfillsymbollayer.cpp.

double QgsSVGFillSymbolLayer::patternWidth ( ) const
inline

Definition at line 863 of file qgsfillsymbollayer.h.

const QgsMapUnitScale& QgsSVGFillSymbolLayer::patternWidthMapUnitScale ( ) const
inline

Definition at line 885 of file qgsfillsymbollayer.h.

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 882 of file qgsfillsymbollayer.h.

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

void QgsSVGFillSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsImageFillSymbolLayer.

Definition at line 1807 of file qgsfillsymbollayer.cpp.

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, eg 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 1788 of file qgsfillsymbollayer.cpp.

void QgsSVGFillSymbolLayer::setPatternWidth ( double  width)
inline

Definition at line 862 of file qgsfillsymbollayer.h.

void QgsSVGFillSymbolLayer::setPatternWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 884 of file qgsfillsymbollayer.h.

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 877 of file qgsfillsymbollayer.h.

void QgsSVGFillSymbolLayer::setSvgFilePath ( const QString &  svgPath)

Definition at line 1826 of file qgsfillsymbollayer.cpp.

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

Definition at line 865 of file qgsfillsymbollayer.h.

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

Definition at line 868 of file qgsfillsymbollayer.h.

void QgsSVGFillSymbolLayer::setSvgOutlineWidth ( double  w)
inline

Definition at line 870 of file qgsfillsymbollayer.h.

void QgsSVGFillSymbolLayer::setSvgOutlineWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 898 of file qgsfillsymbollayer.h.

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

Sets the units for the outline width.

Parameters
unitwidth units
See also
svgOutlineWidthUnit()

Definition at line 891 of file qgsfillsymbollayer.h.

void QgsSVGFillSymbolLayer::startRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 2001 of file qgsfillsymbollayer.cpp.

void QgsSVGFillSymbolLayer::stopRender ( QgsSymbolRenderContext context)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 2012 of file qgsfillsymbollayer.cpp.

QString QgsSVGFillSymbolLayer::svgFilePath ( ) const
inline

Definition at line 861 of file qgsfillsymbollayer.h.

QColor QgsSVGFillSymbolLayer::svgFillColor ( ) const
inline

Definition at line 866 of file qgsfillsymbollayer.h.

QColor QgsSVGFillSymbolLayer::svgOutlineColor ( ) const
inline

Definition at line 869 of file qgsfillsymbollayer.h.

double QgsSVGFillSymbolLayer::svgOutlineWidth ( ) const
inline

Definition at line 871 of file qgsfillsymbollayer.h.

const QgsMapUnitScale& QgsSVGFillSymbolLayer::svgOutlineWidthMapUnitScale ( ) const
inline

Definition at line 899 of file qgsfillsymbollayer.h.

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

Returns the units for the outline width.

See also
setSvgOutlineWidthUnit()

Definition at line 896 of file qgsfillsymbollayer.h.

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

Reimplemented from QgsSymbolLayer.

Definition at line 2083 of file qgsfillsymbollayer.cpp.

Member Data Documentation

double QgsSVGFillSymbolLayer::mPatternWidth
protected

Width of the pattern (in output units)

Definition at line 909 of file qgsfillsymbollayer.h.

QgsMapUnitScale QgsSVGFillSymbolLayer::mPatternWidthMapUnitScale
protected

Definition at line 911 of file qgsfillsymbollayer.h.

QgsUnitTypes::RenderUnit QgsSVGFillSymbolLayer::mPatternWidthUnit
protected

Definition at line 910 of file qgsfillsymbollayer.h.

QByteArray QgsSVGFillSymbolLayer::mSvgData
protected

SVG data.

Definition at line 914 of file qgsfillsymbollayer.h.

QString QgsSVGFillSymbolLayer::mSvgFilePath
protected

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

Definition at line 916 of file qgsfillsymbollayer.h.

QColor QgsSVGFillSymbolLayer::mSvgOutlineColor
protected

Definition at line 924 of file qgsfillsymbollayer.h.

double QgsSVGFillSymbolLayer::mSvgOutlineWidth
protected

Definition at line 925 of file qgsfillsymbollayer.h.

QgsMapUnitScale QgsSVGFillSymbolLayer::mSvgOutlineWidthMapUnitScale
protected

Definition at line 927 of file qgsfillsymbollayer.h.

QgsUnitTypes::RenderUnit QgsSVGFillSymbolLayer::mSvgOutlineWidthUnit
protected

Definition at line 926 of file qgsfillsymbollayer.h.

QImage* QgsSVGFillSymbolLayer::mSvgPattern
protected

SVG pattern image.

Definition at line 920 of file qgsfillsymbollayer.h.

QRectF QgsSVGFillSymbolLayer::mSvgViewBox
protected

SVG view box (to keep the aspect ratio.

Definition at line 918 of file qgsfillsymbollayer.h.


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