Animated marker symbol layer class. More...

#include <qgsmarkersymbollayer.h>

Inheritance diagram for QgsAnimatedMarkerSymbolLayer:

[legend]

Public Member Functions
	QgsAnimatedMarkerSymbolLayer (const QString &path=QString(), double size=DEFAULT_RASTERMARKER_SIZE, double angle=DEFAULT_RASTERMARKER_ANGLE)
	Constructor for animated marker symbol layer using the specified source image path.

	~QgsAnimatedMarkerSymbolLayer () override

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

double	frameRate () const
	Returns the marker frame rate in frame per second.

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

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

void	setFrameRate (double rate)
	Sets the marker frame rate in frame per second.

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

Public Member Functions inherited from QgsRasterMarkerSymbolLayer
	QgsRasterMarkerSymbolLayer (const QString &path=QString(), double size=DEFAULT_SVGMARKER_SIZE, double angle=DEFAULT_SVGMARKER_ANGLE, Qgis::ScaleMethod scaleMethod=DEFAULT_SCALE_METHOD)
	Constructs raster marker symbol layer with picture from given absolute path to a raster image file.

	~QgsRasterMarkerSymbolLayer () 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.

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

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

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

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

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

double	opacity () const
	Returns the marker opacity.

QString	path () const
	Returns the marker raster image path.

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	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	setOpacity (double opacity)
	Set the marker opacity.

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

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

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

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

Public Member Functions inherited from QgsMarkerSymbolLayer
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::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer.

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	setOutputUnit (Qgis::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer.

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

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.

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

Public Member Functions inherited from QgsSymbolLayer
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.

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 QColor	fillColor () const
	Returns the fill color for the symbol layer.

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	prepareExpressions (const QgsSymbolRenderContext &context)
	Prepares all data defined property expressions for evaluation.

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.

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

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 void	setStrokeColor (const QColor &color)
	Sets the stroke color for the symbol layer.

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 QColor	strokeColor () const
	Returns the stroke color for the symbol layer.

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

Qgis::SymbolType	type () const

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

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

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

Static Public Member Functions
static QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates an animated marker symbol layer from a string map of properties.

Static Public Member Functions inherited from QgsRasterMarkerSymbolLayer
static QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates a raster marker symbol layer from a string map of properties.

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
QImage	fetchImage (QgsRenderContext &context, const QString &path, QSize size, bool preserveAspectRatio, double opacity) const override
	Fetches the image to render.

Protected Member Functions inherited from QgsRasterMarkerSymbolLayer
void	copyCommonProperties (QgsRasterMarkerSymbolLayer *other) const
	Copies common properties to another layer.

void	setCommonProperties (const QVariantMap &properties)
	Sets common class properties from a properties map.

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

	QgsMarkerSymbolLayer (const QgsMarkerSymbolLayer &other)

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 (const QgsSymbolLayer &other)

	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.

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.

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

double	mFixedAspectRatio = 0.0
	The marker fixed aspect ratio.

double	mOpacity = 1.0
	The marker default opacity.

QString	mPath

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.

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

Animated marker symbol layer class.

The QgsAnimatedMarkerSymbolLayer class renders frames from an animated raster image source (e.g. an animated GIF) during temporal animations or map exports.

Since: QGIS 3.26

Definition at line 1077 of file qgsmarkersymbollayer.h.

Constructor & Destructor Documentation

◆ QgsAnimatedMarkerSymbolLayer()

QgsAnimatedMarkerSymbolLayer::QgsAnimatedMarkerSymbolLayer	(	const QString &	path = `QString()`,
		double	size = `DEFAULT_RASTERMARKER_SIZE`,
		double	angle = `DEFAULT_RASTERMARKER_ANGLE`
	)

Constructor for animated marker symbol layer using the specified source image path.

Definition at line 4033 of file qgsmarkersymbollayer.cpp.

◆ ~QgsAnimatedMarkerSymbolLayer()

QgsAnimatedMarkerSymbolLayer::~QgsAnimatedMarkerSymbolLayer ( )

overridedefault

Member Function Documentation

◆ clone()

QgsAnimatedMarkerSymbolLayer * QgsAnimatedMarkerSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 4073 of file qgsmarkersymbollayer.cpp.

◆ create()

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

static

Creates an animated marker symbol layer from a string map of properties.

Definition at line 4041 of file qgsmarkersymbollayer.cpp.

◆ fetchImage()

QImage QgsAnimatedMarkerSymbolLayer::fetchImage	(	QgsRenderContext &	context,
		const QString &	path,
		QSize	size,
		bool	preserveAspectRatio,
		double	opacity
	)		const

overrideprotectedvirtual

Fetches the image to render.

Note: Not available in Python bindings

Reimplemented from QgsRasterMarkerSymbolLayer.

Definition at line 4097 of file qgsmarkersymbollayer.cpp.

◆ frameRate()

double QgsAnimatedMarkerSymbolLayer::frameRate ( ) const

inline

Returns the marker frame rate in frame per second.

See also: setFrameRate()

Definition at line 1115 of file qgsmarkersymbollayer.h.

◆ layerType()

QString QgsAnimatedMarkerSymbolLayer::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 4061 of file qgsmarkersymbollayer.cpp.

◆ properties()

QVariantMap QgsAnimatedMarkerSymbolLayer::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 4066 of file qgsmarkersymbollayer.cpp.

◆ setFrameRate()

void QgsAnimatedMarkerSymbolLayer::setFrameRate ( double rate )

inline

Sets the marker frame rate in frame per second.

See also: frameRate()

Definition at line 1108 of file qgsmarkersymbollayer.h.

◆ startRender()

void QgsAnimatedMarkerSymbolLayer::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 4081 of file qgsmarkersymbollayer.cpp.

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

/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/symbology/qgsmarkersymbollayer.h
/build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/symbology/qgsmarkersymbollayer.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsAnimatedMarkerSymbolLayer()

◆ ~QgsAnimatedMarkerSymbolLayer()

Member Function Documentation

◆ clone()

◆ create()

◆ fetchImage()

◆ frameRate()

◆ layerType()

◆ properties()

◆ setFrameRate()

◆ startRender()