#include <qgsmarkersymbollayer.h>

Inheritance diagram for QgsSvgMarkerSymbolLayer:

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

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

QgsSvgMarkerSymbolLayer *	clone () const override
	Shall be reimplemented by subclasses to create a deep copy of the instance.

double	defaultAspectRatio () const
	Returns the default marker aspect ratio between width and height, 0 if not yet calculated.

QColor	fillColor () const override
	Returns the fill color for the symbol layer.

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.

Qgis::SymbolLayerFlags	flags () const override
	Returns flags which control the symbol layer's behavior.

QString	layerType () const override
	Returns a string that represents this layer type.

QgsMapUnitScale	mapUnitScale () const override

Qgis::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer.

QMap< QString, QgsProperty >	parameters () const
	Returns the dynamic SVG parameters.

QString	path () const
	Returns the marker SVG path.

void	prepareExpressions (const QgsSymbolRenderContext &context) override
	Prepares all data defined property expressions for evaluation.

bool	preservedAspectRatio () const
	Returns the preserved aspect ratio value, `true` if fixed aspect ratio has been lower or equal to 0.

QVariantMap	properties () const override
	Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

void	renderPoint (QPointF point, QgsSymbolRenderContext &context) override
	Renders a marker at the specified point.

void	setFillColor (const QColor &color) override
	Sets the fill color for the symbol layer.

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.

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.

void	setParameters (const QMap< QString, QgsProperty > &parameters)
	Sets the dynamic SVG parameters.

void	setPath (const QString &path)
	Set the marker SVG path.

bool	setPreservedAspectRatio (bool par)
	Set preserved the marker aspect ratio between width and height.

void	setStrokeColor (const QColor &c) override
	Sets the stroke color for the symbol layer.

void	setStrokeWidth (double w)

void	setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setStrokeWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the stroke width.

void	startRender (QgsSymbolRenderContext &context) override
	Called before a set of rendering operations commences on the supplied render context.

void	stopRender (QgsSymbolRenderContext &context) override
	Called after a set of rendering operations has finished on the supplied render context.

QColor	strokeColor () const override
	Returns the stroke color for the symbol layer.

double	strokeWidth () const

const QgsMapUnitScale &	strokeWidthMapUnitScale () const

Qgis::RenderUnit	strokeWidthUnit () const
	Returns the units for the stroke width.

double	updateDefaultAspectRatio ()
	Calculates the default marker aspect ratio between width and height.

QSet< QString >	usedAttributes (const QgsRenderContext &context) const override
	Returns the set of attributes referenced by the layer.

bool	usesMapUnits () const override
	Returns `true` if the symbol layer has any components which use map unit based sizes.

bool	writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const override
	write as DXF

void	writeSldMarker (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
	Writes the symbol layer definition as a SLD XML element.

Public Member Functions inherited from QgsMarkerSymbolLayer
	QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)=delete

double	angle () const
	Returns the rotation angle for the marker, in degrees clockwise from north.

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

virtual double	dxfAngle (QgsSymbolRenderContext &context) const override
	Gets angle.

virtual double	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
	Gets marker size.

HorizontalAnchorPoint	horizontalAnchorPoint () const
	Returns the horizontal anchor point for positioning the symbol.

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.

const QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale for the symbol's offset.

Qgis::RenderUnit	offsetUnit () const
	Returns the units for the symbol's offset.

QgsMarkerSymbolLayer &	operator= (const QgsMarkerSymbolLayer &other)=delete

Qgis::ScaleMethod	scaleMethod () const
	Returns the method to use for scaling the marker's size.

void	setAngle (double angle)
	Sets the rotation angle for the marker.

void	setHorizontalAnchorPoint (HorizontalAnchorPoint h)
	Sets the horizontal anchor point for positioning the symbol.

void	setLineAngle (double lineAngle)
	Sets the line angle modification for the symbol's angle.

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.

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the symbol's offset.

void	setOffsetUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's offset.

void	setScaleMethod (Qgis::ScaleMethod scaleMethod)
	Sets the method to use for scaling the marker's size.

virtual void	setSize (double size)
	Sets the symbol size.

void	setSizeMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale for the symbol's size.

void	setSizeUnit (Qgis::RenderUnit unit)
	Sets the units for the symbol's size.

void	setVerticalAnchorPoint (VerticalAnchorPoint v)
	Sets the vertical anchor point for positioning the symbol.

double	size () const
	Returns the symbol size.

const QgsMapUnitScale &	sizeMapUnitScale () const
	Returns the map unit scale for the symbol's size.

Qgis::RenderUnit	sizeUnit () const
	Returns the units for the symbol's size.

void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
	Saves the symbol layer as SLD.

VerticalAnchorPoint	verticalAnchorPoint () const
	Returns the vertical anchor point for positioning the symbol.

Public Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete

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.

virtual QColor	color () const
	Returns the "representative" color of the symbol layer.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () const
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

virtual QColor	dxfBrushColor (QgsSymbolRenderContext &context) const
	Gets brush/fill color.

virtual Qt::BrushStyle	dxfBrushStyle () const
	Gets brush/fill style.

virtual QColor	dxfColor (QgsSymbolRenderContext &context) const
	Gets color.

virtual QVector< qreal >	dxfCustomDashPattern (Qgis::RenderUnit &unit) const
	Gets dash pattern.

virtual double	dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets offset.

virtual Qt::PenStyle	dxfPenStyle () const
	Gets pen style.

virtual double	dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets line width.

bool	enabled () const
	Returns `true` if symbol layer is enabled and will be drawn.

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.

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

QString	id () const
	Returns symbol layer identifier This id is unique in the whole project.

bool	installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF())
	When rendering, install masks on context painter.

virtual bool	isCompatibleWithSymbol (QgsSymbol *symbol) const
	Returns if the layer can be used below the specified symbol.

bool	isLocked () const
	Returns `true` if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.

virtual QList< QgsSymbolLayerReference >	masks () const
	Returns masks defined by this symbol layer.

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete

QgsPaintEffect *	paintEffect () const
	Returns the current paint effect for the layer.

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.

int	renderingPass () const
	Specifies the rendering pass in which this symbol layer should be rendered.

virtual void	setColor (const QColor &color)
	Sets the "representative" color for the symbol layer.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the symbol layer's property collection, used for data defined overrides.

virtual void	setDataDefinedProperty (Property key, const QgsProperty &property)
	Sets a data defined property for the layer.

void	setEnabled (bool enabled)
	Sets whether symbol layer is enabled and should be drawn.

void	setId (const QString &id)
	Set symbol layer identifier This id has to be unique in the whole project.

void	setLocked (bool locked)
	Sets whether the layer's colors are locked.

void	setPaintEffect (QgsPaintEffect *effect)
	Sets the current paint effect for the layer.

void	setRenderingPass (int renderingPass)
	Specifies the rendering pass in which this symbol layer should be rendered.

virtual bool	setSubSymbol (QgsSymbol *symbol)
	Sets layer's subsymbol. takes ownership of the passed symbol.

void	setUserFlags (Qgis::SymbolLayerUserFlags flags)
	Sets user-controlled flags which control the symbol layer's behavior.

virtual void	startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called before the layer will be rendered for a particular feature.

virtual void	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature.

virtual QgsSymbol *	subSymbol ()
	Returns the symbol's sub symbol, if present.

Qgis::SymbolType	type () const

Qgis::SymbolLayerUserFlags	userFlags () const
	Returns user-controlled flags which control the symbol layer's behavior.

Static Public Member Functions
static QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates the symbol.

static QgsSymbolLayer *	createFromSld (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.

Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions.

Protected Member Functions
double	calculateAspectRatio (QgsSymbolRenderContext &context, double scaledSize, bool &hasDataDefinedAspectRatio) const
	Calculates the marker aspect ratio between width and height.

Protected Member Functions inherited from QgsMarkerSymbolLayer
	QgsMarkerSymbolLayer (bool locked=false)
	Constructor for QgsMarkerSymbolLayer.

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.

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.

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.

void	copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
	Copies all data defined properties of this layer to another symbol layer.

void	copyPaintEffect (QgsSymbolLayer *destLayer) const
	Copies paint effect of this layer to another symbol layer.

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.

void	restoreOldDataDefinedProperties (const QVariantMap &stringMap)
	Restores older data defined properties from string map.

bool	shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
	Returns `true` if the symbol layer should be rendered using the selection color from the render context.

Protected Attributes
double	mDefaultAspectRatio = 0.0
	The marker default aspect ratio.

double	mFixedAspectRatio = 0.0
	The marker fixed aspect ratio.

bool	mHasFillParam = false

QMap< QString, QgsProperty >	mParameters

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.

HorizontalAnchorPoint	mHorizontalAnchorPoint = HCenter
	Horizontal anchor point.

double	mLineAngle = 0
	Line rotation angle (see setLineAngle() for details)

QPointF	mOffset
	Marker offset.

QgsMapUnitScale	mOffsetMapUnitScale
	Offset map unit scale.

Qgis::RenderUnit	mOffsetUnit = Qgis::RenderUnit::Millimeters
	Offset units.

Qgis::ScaleMethod	mScaleMethod = Qgis::ScaleMethod::ScaleDiameter
	Marker size scaling method.

double	mSize = 2.0
	Marker size.

QgsMapUnitScale	mSizeMapUnitScale
	Marker size map unit scale.

Qgis::RenderUnit	mSizeUnit = Qgis::RenderUnit::Millimeters
	Marker size unit.

VerticalAnchorPoint	mVerticalAnchorPoint = VCenter
	Vertical anchor point.

Protected Attributes inherited from QgsSymbolLayer
QPainterPath	mClipPath

QColor	mColor

QgsPropertyCollection	mDataDefinedProperties

bool	mEnabled = true
	True if layer is enabled and should be drawn.

QgsFields	mFields

QString	mId

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

Qgis::SymbolLayerUserFlags	mUserFlags
	User controlled flags.

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 , SkipMultiples , ShowMarker }
	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.

Static Protected Attributes inherited from QgsSymbolLayer
static const bool	SELECT_FILL_BORDER = false
	Whether fill styles for selected features also highlight symbol stroke.

static const bool	SELECT_FILL_STYLE = false
	Whether fill styles for selected features uses symbol layer style.

static const bool	SELECTION_IS_OPAQUE = true
	Whether styles for selected features ignore symbol alpha.

Detailed Description

Definition at line 491 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 2090 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 2935 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

context	symbol render context
scaledSize	size of symbol to render
hasDataDefinedAspectRatio	will be set to `true` if marker has data defined aspectRatio

Definition at line 2503 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 2616 of file qgsmarkersymbollayer.cpp.

◆ create()

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

static

Creates the symbol.

Definition at line 2105 of file qgsmarkersymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsSvgMarkerSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 2701 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 543 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 583 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 572 of file qgsmarkersymbollayer.h.

◆ flags()

Qgis::SymbolLayerFlags QgsSvgMarkerSymbolLayer::flags ( ) const

overridevirtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented from QgsSymbolLayer.

Definition at line 2309 of file qgsmarkersymbollayer.cpp.

◆ 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 2304 of file qgsmarkersymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSvgMarkerSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2661 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 QgsMarkerSymbolLayer.

Definition at line 2645 of file qgsmarkersymbollayer.cpp.

◆ parameters()

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

inline

Returns the dynamic SVG parameters.

Since: QGIS 3.18

Definition at line 596 of file qgsmarkersymbollayer.h.

◆ path()

QString QgsSvgMarkerSymbolLayer::path ( ) const

inline

Returns the marker SVG path.

See also: setPath()

Definition at line 530 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

context symbol render context

Reimplemented from QgsSymbolLayer.

Definition at line 4010 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 556 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 2583 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

point	position at which to render point, in painter units
context	symbol render context

Implements QgsMarkerSymbolLayer.

Definition at line 2325 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 2205 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 584 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

ratio Fixed Aspect Ratio

See also: fixedAspectRatio(); QgsSvgCache

Definition at line 581 of file qgsmarkersymbollayer.h.

◆ setMapUnitScale()

void QgsSvgMarkerSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2655 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

unit	output units

See also: outputUnit()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2639 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 2298 of file qgsmarkersymbollayer.cpp.

◆ setPath()

void QgsSvgMarkerSymbolLayer::setPath ( const QString & path )

Set the marker SVG path.

Parameters

path SVG path

See also: path()

Definition at line 2221 of file qgsmarkersymbollayer.cpp.

◆ setPreservedAspectRatio()

bool QgsSvgMarkerSymbolLayer::setPreservedAspectRatio ( bool par )

Set preserved the marker aspect ratio between width and height.

Parameters

par	Preserved 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 2284 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 587 of file qgsmarkersymbollayer.h.

◆ setStrokeWidth()

void QgsSvgMarkerSymbolLayer::setStrokeWidth ( double w )

inline

Definition at line 590 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthMapUnitScale()

void QgsSvgMarkerSymbolLayer::setStrokeWidthMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 617 of file qgsmarkersymbollayer.h.

◆ setStrokeWidthUnit()

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

inline

Sets the units for the stroke width.

Parameters

unit	width units

See also: strokeWidthUnit()

Definition at line 609 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()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2314 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()

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2320 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 586 of file qgsmarkersymbollayer.h.

◆ strokeWidth()

double QgsSvgMarkerSymbolLayer::strokeWidth ( ) const

inline

Definition at line 589 of file qgsmarkersymbollayer.h.

◆ strokeWidthMapUnitScale()

const QgsMapUnitScale & QgsSvgMarkerSymbolLayer::strokeWidthMapUnitScale ( ) const

inline

Definition at line 618 of file qgsmarkersymbollayer.h.

◆ strokeWidthUnit()

Qgis::RenderUnit QgsSvgMarkerSymbolLayer::strokeWidthUnit ( ) const

inline

Returns the units for the stroke width.

See also: strokeWidthUnit()

Definition at line 615 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 2269 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 4020 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 2609 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 2814 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

doc	XML document
element	parent XML element
props	symbol layer definition (see properties())

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 2670 of file qgsmarkersymbollayer.cpp.

Member Data Documentation

◆ mDefaultAspectRatio

double QgsSvgMarkerSymbolLayer::mDefaultAspectRatio = 0.0

protected

The marker default aspect ratio.

Definition at line 647 of file qgsmarkersymbollayer.h.

◆ mFixedAspectRatio

double QgsSvgMarkerSymbolLayer::mFixedAspectRatio = 0.0

protected

The marker fixed aspect ratio.

Definition at line 649 of file qgsmarkersymbollayer.h.

◆ mHasFillParam

bool QgsSvgMarkerSymbolLayer::mHasFillParam = false

protected

Definition at line 652 of file qgsmarkersymbollayer.h.

◆ mParameters

QMap<QString, QgsProperty> QgsSvgMarkerSymbolLayer::mParameters

protected

Definition at line 655 of file qgsmarkersymbollayer.h.

◆ mPath

QString QgsSvgMarkerSymbolLayer::mPath

protected

Definition at line 644 of file qgsmarkersymbollayer.h.

◆ mStrokeColor

QColor QgsSvgMarkerSymbolLayer::mStrokeColor

protected

Definition at line 653 of file qgsmarkersymbollayer.h.

◆ mStrokeWidth

double QgsSvgMarkerSymbolLayer::mStrokeWidth

protected

Definition at line 654 of file qgsmarkersymbollayer.h.

◆ mStrokeWidthMapUnitScale

QgsMapUnitScale QgsSvgMarkerSymbolLayer::mStrokeWidthMapUnitScale

protected

Definition at line 658 of file qgsmarkersymbollayer.h.

◆ mStrokeWidthUnit

Qgis::RenderUnit QgsSvgMarkerSymbolLayer::mStrokeWidthUnit

protected

Definition at line 657 of file qgsmarkersymbollayer.h.

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

/build/qgis-3.40.0+99sid/src/core/symbology/qgsmarkersymbollayer.h
/build/qgis-3.40.0+99sid/src/core/symbology/qgsmarkersymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsSvgMarkerSymbolLayer()

◆ ~QgsSvgMarkerSymbolLayer()

Member Function Documentation

◆ bounds()

◆ calculateAspectRatio()

◆ clone()

◆ create()

◆ createFromSld()

◆ defaultAspectRatio()

◆ fillColor()

◆ fixedAspectRatio()

◆ flags()

◆ layerType()

◆ mapUnitScale()

◆ outputUnit()

◆ parameters()

◆ path()

◆ prepareExpressions()

◆ preservedAspectRatio()

◆ properties()

◆ renderPoint()

◆ resolvePaths()

◆ setFillColor()

◆ setFixedAspectRatio()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setParameters()

◆ setPath()

◆ setPreservedAspectRatio()

◆ setStrokeColor()

◆ setStrokeWidth()

◆ setStrokeWidthMapUnitScale()

◆ setStrokeWidthUnit()

◆ startRender()

◆ stopRender()

◆ strokeColor()

◆ strokeWidth()

◆ strokeWidthMapUnitScale()

◆ strokeWidthUnit()

◆ updateDefaultAspectRatio()

◆ usedAttributes()

◆ usesMapUnits()

◆ writeDxf()

◆ writeSldMarker()

Member Data Documentation

◆ mDefaultAspectRatio

◆ mFixedAspectRatio

◆ mHasFillParam

◆ mParameters

◆ mPath

◆ mStrokeColor

◆ mStrokeWidth

◆ mStrokeWidthMapUnitScale

◆ mStrokeWidthUnit