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

#include <qgsmarkersymbollayer.h>

Inheritance diagram for QgsSvgMarkerSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsSvgMarkerSymbolLayer (const QString &path, double size=DEFAULT_SVGMARKER_SIZE, double angle=DEFAULT_SVGMARKER_ANGLE, Qgis::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD)
 Constructs SVG marker symbol layer with picture from given absolute path to a SVG file. More...
 
 ~QgsSvgMarkerSymbolLayer () override
 
QRectF bounds (QPointF point, QgsSymbolRenderContext &context) override
 Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. More...
 
QgsSvgMarkerSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
double defaultAspectRatio () const
 Returns the default marker aspect ratio between width and height, 0 if not yet calculated. More...
 
QColor fillColor () const override
 Returns the fill color for the symbol layer. More...
 
double fixedAspectRatio () const
 Returns the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering. 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...
 
QString path () const
 Returns the marker SVG path. More...
 
void prepareExpressions (const QgsSymbolRenderContext &context) override
 Prepares all data defined property expressions for evaluation. More...
 
bool preservedAspectRatio () const
 Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0. 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 renderPoint (QPointF point, QgsSymbolRenderContext &context) override
 Renders a marker at the specified point. More...
 
void setFillColor (const QColor &color) override
 Sets the fill color for the symbol layer. More...
 
void setFixedAspectRatio (double ratio)
 Set the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering. 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 setPath (const QString &path)
 Set the marker SVG path. More...
 
bool setPreservedAspectRatio (bool par)
 Set preserved the marker aspect ratio between width and height. More...
 
void setStrokeColor (const QColor &c) override
 Sets the stroke color for the symbol layer. More...
 
void setStrokeWidth (double w)
 
void setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setStrokeWidthUnit (Qgis::RenderUnit unit)
 Sets the units 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...
 
QColor strokeColor () const override
 Returns the stroke color for the symbol layer. More...
 
double strokeWidth () const
 
const QgsMapUnitScalestrokeWidthMapUnitScale () const
 
Qgis::RenderUnit strokeWidthUnit () const
 Returns the units for the stroke width. More...
 
double updateDefaultAspectRatio ()
 Calculates the default marker aspect ratio between width and height. 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...
 
bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override
 write as DXF More...
 
void writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Writes the symbol layer definition as a SLD XML element. More...
 
- Public Member Functions inherited from QgsMarkerSymbolLayer
 QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)=delete
 QgsMarkerSymbolLayer cannot be copied. More...
 
double angle () const
 Returns the rotation angle for the marker, in degrees clockwise from north. More...
 
virtual QRectF bounds (QPointF point, QgsSymbolRenderContext &context)=0
 Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer. More...
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const override
 Gets angle. More...
 
virtual double dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets marker size. More...
 
HorizontalAnchorPoint horizontalAnchorPoint () const
 Returns the horizontal anchor point for positioning the symbol. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QPointF offset () const
 Returns the marker's offset, which is the horizontal and vertical displacement which the rendered marker will have from the original feature's geometry. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the symbol's offset. More...
 
Qgis::RenderUnit offsetUnit () const
 Returns the units for the symbol's offset. More...
 
QgsMarkerSymbolLayeroperator= (const QgsMarkerSymbolLayer &other)=delete
 QgsMarkerSymbolLayer cannot be copied. More...
 
Qgis::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
virtual void renderPoint (QPointF point, QgsSymbolRenderContext &context)=0
 Renders a marker at the specified point. More...
 
Qgis::ScaleMethod scaleMethod () const
 Returns the method to use for scaling the marker's size. More...
 
void setAngle (double angle)
 Sets the rotation angle for the marker. More...
 
void setHorizontalAnchorPoint (HorizontalAnchorPoint h)
 Sets the horizontal anchor point for positioning the symbol. More...
 
void setLineAngle (double lineAngle)
 Sets the line angle modification for the symbol's angle. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOffset (QPointF offset)
 Sets the marker's offset, which is the horizontal and vertical displacement which the rendered marker should have from the original feature's geometry. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the symbol's offset. More...
 
void setOffsetUnit (Qgis::RenderUnit unit)
 Sets the units for the symbol's offset. More...
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setScaleMethod (Qgis::ScaleMethod scaleMethod)
 Sets the method to use for scaling the marker's size. More...
 
virtual void setSize (double size)
 Sets the symbol size. More...
 
void setSizeMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the symbol's size. More...
 
void setSizeUnit (Qgis::RenderUnit unit)
 Sets the units for the symbol's size. More...
 
void setVerticalAnchorPoint (VerticalAnchorPoint v)
 Sets the vertical anchor point for positioning the symbol. More...
 
double size () const
 Returns the symbol size. More...
 
const QgsMapUnitScalesizeMapUnitScale () const
 Returns the map unit scale for the symbol's size. More...
 
Qgis::RenderUnit sizeUnit () const
 Returns the units for the symbol's size. 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...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD. More...
 
VerticalAnchorPoint verticalAnchorPoint () const
 Returns the vertical anchor point for positioning the symbol. More...
 
virtual void writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Writes the symbol layer definition as a SLD XML element. 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 QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. 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 void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0
 
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 QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color. 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 Qt::PenStyle dxfPenStyle () const
 Gets pen style. More...
 
virtual double dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets marker size. More...
 
virtual double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets line width. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual double estimateMaxBleed (const QgsRenderContext &context) const
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. 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...
 
virtual bool hasDataDefinedProperties () const
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. 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 QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QgsMapUnitScale mapUnitScale () const
 
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...
 
virtual Qgis::RenderUnit outputUnit () const
 Returns the units to use for sizes and widths within the symbol layer. 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...
 
virtual QVariantMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. 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...
 
virtual void setMapUnitScale (const QgsMapUnitScale &scale)
 
virtual void setOutputUnit (Qgis::RenderUnit unit)
 Sets the units to use for sizes and widths within the symbol layer. 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...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. 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 startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context. More...
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
Qgis::SymbolLayerUserFlags userFlags () const
 Returns user-controlled flags which control the symbol layer's behavior. More...
 
virtual bool usesMapUnits () const
 Returns true if the symbol layer has any components which use map unit based sizes. 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 the symbol. More...
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 
static void resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving)
 Turns relative paths in properties map to absolute when reading and vice versa when writing. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

Protected Member Functions

double calculateAspectRatio (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio) const
 Calculates the marker aspect ratio between width and height. More...
 
- Protected Member Functions inherited from QgsMarkerSymbolLayer
 QgsMarkerSymbolLayer (bool locked=false)
 Constructor for QgsMarkerSymbolLayer. More...
 
void markerOffset (QgsSymbolRenderContext &context, double &offsetX, double &offsetY) const
 Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More...
 
void markerOffset (QgsSymbolRenderContext &context, double width, double height, double &offsetX, double &offsetY) const
 Calculates the required marker offset, including both the symbol offset and any displacement required to align with the marker's anchor point. More...
 
void markerOffset (QgsSymbolRenderContext &context, double width, double height, Qgis::RenderUnit widthUnit, Qgis::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const
 
- 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...
 

Protected Attributes

double mDefaultAspectRatio = 0.0
 The marker default aspect ratio. More...
 
double mFixedAspectRatio = 0.0
 The marker fixed aspect ratio. More...
 
bool mHasFillParam = false
 
QMap< QString, QgsPropertymParameters
 
QString mPath
 
QColor mStrokeColor
 
double mStrokeWidth
 
QgsMapUnitScale mStrokeWidthMapUnitScale
 
Qgis::RenderUnit mStrokeWidthUnit
 
- Protected Attributes inherited from QgsMarkerSymbolLayer
double mAngle = 0
 Marker rotation angle, in degrees clockwise from north. More...
 
HorizontalAnchorPoint mHorizontalAnchorPoint = HCenter
 Horizontal anchor point. More...
 
double mLineAngle = 0
 Line rotation angle (see setLineAngle() for details) More...
 
QPointF mOffset
 Marker offset. More...
 
QgsMapUnitScale mOffsetMapUnitScale
 Offset map unit scale. More...
 
Qgis::RenderUnit mOffsetUnit = Qgis::RenderUnit::Millimeters
 Offset units. More...
 
Qgis::ScaleMethod mScaleMethod = Qgis::ScaleMethod::ScaleDiameter
 Marker size scaling method. More...
 
double mSize = 2.0
 Marker size. More...
 
QgsMapUnitScale mSizeMapUnitScale
 Marker size map unit scale. More...
 
Qgis::RenderUnit mSizeUnit = Qgis::RenderUnit::Millimeters
 Marker size unit. More...
 
VerticalAnchorPoint mVerticalAnchorPoint = VCenter
 Vertical anchor point. More...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from QgsMarkerSymbolLayer
enum  HorizontalAnchorPoint { Left , HCenter , Right }
 Symbol horizontal anchor points. More...
 
enum  VerticalAnchorPoint { Top , VCenter , Bottom }
 Symbol vertical anchor points. More...
 
- 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...
 
- Static Protected Member Functions inherited from QgsMarkerSymbolLayer
static QPointF _rotatedOffset (QPointF offset, double angle)
 Adjusts a marker offset to account for rotation. 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

Definition at line 490 of file qgsmarkersymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSvgMarkerSymbolLayer()

QgsSvgMarkerSymbolLayer::QgsSvgMarkerSymbolLayer ( const QString &  path,
double  size = DEFAULT_SVGMARKER_SIZE,
double  angle = DEFAULT_SVGMARKER_ANGLE,
Qgis::ScaleMethod  scaleMethod = DEFAULT_SCALE_METHOD 
)

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

Definition at line 2097 of file qgsmarkersymbollayer.cpp.

◆ ~QgsSvgMarkerSymbolLayer()

QgsSvgMarkerSymbolLayer::~QgsSvgMarkerSymbolLayer ( )
overridedefault

Member Function Documentation

◆ bounds()

QRectF QgsSvgMarkerSymbolLayer::bounds ( QPointF  point,
QgsSymbolRenderContext context 
)
overridevirtual

Returns the approximate bounding box of the marker symbol layer, taking into account any data defined overrides and offsets which are set for the marker layer.

Returns
approximate symbol bounds, in painter units

Implements QgsMarkerSymbolLayer.

Definition at line 2939 of file qgsmarkersymbollayer.cpp.

◆ calculateAspectRatio()

double QgsSvgMarkerSymbolLayer::calculateAspectRatio ( QgsSymbolRenderContext context,
double  scaledSize,
bool &  hasDataDefinedAspectRatio 
) const
protected

Calculates the marker aspect ratio between width and height.

Parameters
contextsymbol render context
scaledSizesize of symbol to render
hasDataDefinedAspectRatiowill be set to true if marker has data defined aspectRatio

Definition at line 2507 of file qgsmarkersymbollayer.cpp.

◆ clone()

QgsSvgMarkerSymbolLayer * QgsSvgMarkerSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 2620 of file qgsmarkersymbollayer.cpp.

◆ create()

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

Creates the symbol.

Definition at line 2112 of file qgsmarkersymbollayer.cpp.

◆ createFromSld()

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

Definition at line 2705 of file qgsmarkersymbollayer.cpp.

◆ defaultAspectRatio()

double QgsSvgMarkerSymbolLayer::defaultAspectRatio ( ) const
inline

Returns the default marker aspect ratio between width and height, 0 if not yet calculated.

See also
updateDefaultAspectRatio()

Definition at line 547 of file qgsmarkersymbollayer.h.

◆ fillColor()

QColor QgsSvgMarkerSymbolLayer::fillColor ( ) const
inlineoverridevirtual

Returns the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component. Symbol layers without a fill component will return an invalid QColor.

See also
setFillColor()
color()
strokeColor()

Reimplemented from QgsSymbolLayer.

Definition at line 585 of file qgsmarkersymbollayer.h.

◆ fixedAspectRatio()

double QgsSvgMarkerSymbolLayer::fixedAspectRatio ( ) const
inline

Returns the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering.

See also
setFixedAspectRatio() QgsSvgCache

Definition at line 575 of file qgsmarkersymbollayer.h.

◆ layerType()

QString QgsSvgMarkerSymbolLayer::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 2311 of file qgsmarkersymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSvgMarkerSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 2665 of file qgsmarkersymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsSvgMarkerSymbolLayer::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 QgsSymbolLayer.

Definition at line 2649 of file qgsmarkersymbollayer.cpp.

◆ parameters()

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

Returns the dynamic SVG parameters.

Since
QGIS 3.18

Definition at line 598 of file qgsmarkersymbollayer.h.

◆ path()

QString QgsSvgMarkerSymbolLayer::path ( ) const
inline

Returns the marker SVG path.

See also
setPath()

Definition at line 534 of file qgsmarkersymbollayer.h.

◆ prepareExpressions()

void QgsSvgMarkerSymbolLayer::prepareExpressions ( const QgsSymbolRenderContext context)
overridevirtual

Prepares all data defined property expressions for evaluation.

This should be called prior to evaluating data defined properties.

Parameters
contextsymbol render context

Reimplemented from QgsSymbolLayer.

Definition at line 4004 of file qgsmarkersymbollayer.cpp.

◆ preservedAspectRatio()

bool QgsSvgMarkerSymbolLayer::preservedAspectRatio ( ) const
inline

Returns the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0.

See also
setPreservedAspectRatio()

Definition at line 560 of file qgsmarkersymbollayer.h.

◆ properties()

QVariantMap QgsSvgMarkerSymbolLayer::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 2587 of file qgsmarkersymbollayer.cpp.

◆ renderPoint()

void QgsSvgMarkerSymbolLayer::renderPoint ( QPointF  point,
QgsSymbolRenderContext context 
)
overridevirtual

Renders a marker at the specified point.

Derived classes must implement this to handle drawing the point.

Parameters
pointposition at which to render point, in painter units
contextsymbol render context

Implements QgsMarkerSymbolLayer.

Definition at line 2327 of file qgsmarkersymbollayer.cpp.

◆ resolvePaths()

void QgsSvgMarkerSymbolLayer::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 2212 of file qgsmarkersymbollayer.cpp.

◆ setFillColor()

void QgsSvgMarkerSymbolLayer::setFillColor ( const QColor &  color)
inlineoverridevirtual

Sets the fill color for the symbol layer.

This property is not supported by all symbol layer types, only those with a fill component.

See also
fillColor()
setColor()
setStrokeColor()

Reimplemented from QgsSymbolLayer.

Definition at line 586 of file qgsmarkersymbollayer.h.

◆ setFixedAspectRatio()

void QgsSvgMarkerSymbolLayer::setFixedAspectRatio ( double  ratio)
inline

Set the marker aspect ratio between width and height to be used in rendering, if the value set is lower or equal to 0 the aspect ratio will be preserved in rendering.

Parameters
ratioFixed Aspect Ratio
See also
fixedAspectRatio() QgsSvgCache

Definition at line 583 of file qgsmarkersymbollayer.h.

◆ setMapUnitScale()

void QgsSvgMarkerSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 2659 of file qgsmarkersymbollayer.cpp.

◆ setOutputUnit()

void QgsSvgMarkerSymbolLayer::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 QgsSymbolLayer.

Definition at line 2643 of file qgsmarkersymbollayer.cpp.

◆ setParameters()

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

Sets the dynamic SVG parameters.

Since
QGIS 3.18

Definition at line 2305 of file qgsmarkersymbollayer.cpp.

◆ setPath()

void QgsSvgMarkerSymbolLayer::setPath ( const QString &  path)

Set the marker SVG path.

Parameters
pathSVG path
See also
path()

Definition at line 2228 of file qgsmarkersymbollayer.cpp.

◆ setPreservedAspectRatio()

bool QgsSvgMarkerSymbolLayer::setPreservedAspectRatio ( bool  par)

Set preserved the marker aspect ratio between width and height.

Parameters
parPreserved Aspect Ratio
Returns
the preserved aspect ratio value, true if fixed aspect ratio has been lower or equal to 0
See also
preservedAspectRatio()

Definition at line 2291 of file qgsmarkersymbollayer.cpp.

◆ setStrokeColor()

void QgsSvgMarkerSymbolLayer::setStrokeColor ( const QColor &  color)
inlineoverridevirtual

Sets the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component.

See also
strokeColor()
setColor()
setFillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 589 of file qgsmarkersymbollayer.h.

◆ setStrokeWidth()

void QgsSvgMarkerSymbolLayer::setStrokeWidth ( double  w)
inline

Definition at line 592 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsSvgMarkerSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 619 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthUnit()

void QgsSvgMarkerSymbolLayer::setStrokeWidthUnit ( Qgis::RenderUnit  unit)
inline

Sets the units for the stroke width.

Parameters
unitwidth units
See also
strokeWidthUnit()

Definition at line 611 of file qgsmarkersymbollayer.h.

◆ startRender()

void QgsSvgMarkerSymbolLayer::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 2316 of file qgsmarkersymbollayer.cpp.

◆ stopRender()

void QgsSvgMarkerSymbolLayer::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 2322 of file qgsmarkersymbollayer.cpp.

◆ strokeColor()

QColor QgsSvgMarkerSymbolLayer::strokeColor ( ) const
inlineoverridevirtual

Returns the stroke color for the symbol layer.

This property is not supported by all symbol layer types, only those with a stroke component. Symbol layers without a stroke component will return an invalid QColor.

See also
setStrokeColor()
color()
fillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 588 of file qgsmarkersymbollayer.h.

◆ strokeWidth()

double QgsSvgMarkerSymbolLayer::strokeWidth ( ) const
inline

Definition at line 591 of file qgsmarkersymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsSvgMarkerSymbolLayer::strokeWidthMapUnitScale ( ) const
inline

Definition at line 620 of file qgsmarkersymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsSvgMarkerSymbolLayer::strokeWidthUnit ( ) const
inline

Returns the units for the stroke width.

See also
strokeWidthUnit()

Definition at line 617 of file qgsmarkersymbollayer.h.

◆ updateDefaultAspectRatio()

double QgsSvgMarkerSymbolLayer::updateDefaultAspectRatio ( )

Calculates the default marker aspect ratio between width and height.

Returns
the default aspect ratio value
See also
defaultAspectRatio()

Definition at line 2276 of file qgsmarkersymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsSvgMarkerSymbolLayer::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 4014 of file qgsmarkersymbollayer.cpp.

◆ usesMapUnits()

bool QgsSvgMarkerSymbolLayer::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 2613 of file qgsmarkersymbollayer.cpp.

◆ writeDxf()

bool QgsSvgMarkerSymbolLayer::writeDxf ( QgsDxfExport e,
double  mmMapUnitScaleFactor,
const QString &  layerName,
QgsSymbolRenderContext context,
QPointF  shift = QPointF( 0.0, 0.0 ) 
) const
overridevirtual

write as DXF

Reimplemented from QgsSymbolLayer.

Definition at line 2818 of file qgsmarkersymbollayer.cpp.

◆ writeSldMarker()

void QgsSvgMarkerSymbolLayer::writeSldMarker ( QDomDocument &  doc,
QDomElement &  element,
const QVariantMap &  props 
) const
overridevirtual

Writes the symbol layer definition as a SLD XML element.

Parameters
docXML document
elementparent XML element
propssymbol layer definition (see properties())

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2674 of file qgsmarkersymbollayer.cpp.

Member Data Documentation

◆ mDefaultAspectRatio

double QgsSvgMarkerSymbolLayer::mDefaultAspectRatio = 0.0
protected

The marker default aspect ratio.

Definition at line 649 of file qgsmarkersymbollayer.h.

◆ mFixedAspectRatio

double QgsSvgMarkerSymbolLayer::mFixedAspectRatio = 0.0
protected

The marker fixed aspect ratio.

Definition at line 651 of file qgsmarkersymbollayer.h.

◆ mHasFillParam

bool QgsSvgMarkerSymbolLayer::mHasFillParam = false
protected

Definition at line 654 of file qgsmarkersymbollayer.h.

◆ mParameters

QMap<QString, QgsProperty> QgsSvgMarkerSymbolLayer::mParameters
protected

Definition at line 657 of file qgsmarkersymbollayer.h.

◆ mPath

QString QgsSvgMarkerSymbolLayer::mPath
protected

Definition at line 646 of file qgsmarkersymbollayer.h.

◆ mStrokeColor

QColor QgsSvgMarkerSymbolLayer::mStrokeColor
protected

Definition at line 655 of file qgsmarkersymbollayer.h.

◆ mStrokeWidth

double QgsSvgMarkerSymbolLayer::mStrokeWidth
protected

Definition at line 656 of file qgsmarkersymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsSvgMarkerSymbolLayer::mStrokeWidthMapUnitScale
protected

Definition at line 660 of file qgsmarkersymbollayer.h.

◆ mStrokeWidthUnit

Qgis::RenderUnit QgsSvgMarkerSymbolLayer::mStrokeWidthUnit
protected

Definition at line 659 of file qgsmarkersymbollayer.h.


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