A symbol layer class for displaying displacement arrows based on point layer attributes. More...

#include <qgsvectorfieldsymbollayer.h>

Inheritance diagram for QgsVectorFieldSymbolLayer:

[legend]

Public Types
enum	AngleOrientation { ClockwiseFromNorth = 0 , CounterclockwiseFromEast }

enum	AngleUnits { Degrees = 0 , Radians }

enum	VectorFieldType { Cartesian = 0 , Polar , Height }

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

Public Member Functions
	QgsVectorFieldSymbolLayer ()

	~QgsVectorFieldSymbolLayer () override

AngleOrientation	angleOrientation () const

AngleUnits	angleUnits () const

QRectF	bounds (QPointF, QgsSymbolRenderContext &) 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.

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

const QgsMapUnitScale &	distanceMapUnitScale () const

Qgis::RenderUnit	distanceUnit () const
	Returns the units for the distance.

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

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

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.

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.

double	scale () const

void	setAngleOrientation (AngleOrientation orientation)

void	setAngleUnits (AngleUnits units)

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

void	setDistanceMapUnitScale (const QgsMapUnitScale &scale)

void	setDistanceUnit (Qgis::RenderUnit unit)
	Sets the units for the distance.

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	setScale (double s)

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

void	setVectorFieldType (VectorFieldType type)

void	setXAttribute (const QString &attribute)

void	setYAttribute (const QString &attribute)

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.

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

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

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.

VectorFieldType	vectorFieldType () const

QString	xAttribute () const

QString	yAttribute () const

Public Member Functions inherited from QgsMarkerSymbolLayer
double	angle () const
	Returns the rotation angle for the marker, in degrees clockwise from north.

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.

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 Qgis::SymbolLayerFlags	flags () const
	Returns flags which control the symbol layer's behavior.

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.

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.

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.

Qgis::SymbolType	type () const

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 the symbol layer.

static QgsSymbolLayer *	createFromSld (QDomElement &element)

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

Additional Inherited Members
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.

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

A symbol layer class for displaying displacement arrows based on point layer attributes.

Definition at line 31 of file qgsvectorfieldsymbollayer.h.

Member Enumeration Documentation

◆ AngleOrientation

enum QgsVectorFieldSymbolLayer::AngleOrientation

Enumerator
ClockwiseFromNorth
CounterclockwiseFromEast

Definition at line 41 of file qgsvectorfieldsymbollayer.h.

◆ AngleUnits

enum QgsVectorFieldSymbolLayer::AngleUnits

Enumerator
Degrees
Radians

Definition at line 47 of file qgsvectorfieldsymbollayer.h.

◆ VectorFieldType

enum QgsVectorFieldSymbolLayer::VectorFieldType

Enumerator
Cartesian
Polar
Height

Definition at line 34 of file qgsvectorfieldsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsVectorFieldSymbolLayer()

QgsVectorFieldSymbolLayer::QgsVectorFieldSymbolLayer ( )

Definition at line 23 of file qgsvectorfieldsymbollayer.cpp.

◆ ~QgsVectorFieldSymbolLayer()

QgsVectorFieldSymbolLayer::~QgsVectorFieldSymbolLayer ( )

overridedefault

Member Function Documentation

◆ angleOrientation()

AngleOrientation QgsVectorFieldSymbolLayer::angleOrientation ( ) const

inline

Definition at line 93 of file qgsvectorfieldsymbollayer.h.

◆ angleUnits()

AngleUnits QgsVectorFieldSymbolLayer::angleUnits ( ) const

inline

Definition at line 95 of file qgsvectorfieldsymbollayer.h.

◆ bounds()

QRectF QgsVectorFieldSymbolLayer::bounds	(	QPointF	point,
		QgsSymbolRenderContext &	context
	)

inlineoverridevirtual

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 120 of file qgsvectorfieldsymbollayer.h.

◆ clone()

QgsVectorFieldSymbolLayer * QgsVectorFieldSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 251 of file qgsvectorfieldsymbollayer.cpp.

◆ color()

QColor QgsVectorFieldSymbolLayer::color ( ) const

overridevirtual

Returns the "representative" color of the symbol layer.

Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally return the stroke color of the layer, while a fill symbol layer will return the "fill" color instead of stroke.

Some symbol layer types will return an invalid QColor if they have no representative color associated (e.g. raster image based symbol layers).

See also: setColor(); strokeColor(); fillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 367 of file qgsvectorfieldsymbollayer.cpp.

◆ create()

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

static

Creates the symbol layer.

Definition at line 62 of file qgsvectorfieldsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsVectorFieldSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 294 of file qgsvectorfieldsymbollayer.cpp.

◆ distanceMapUnitScale()

const QgsMapUnitScale & QgsVectorFieldSymbolLayer::distanceMapUnitScale ( ) const

inline

Definition at line 117 of file qgsvectorfieldsymbollayer.h.

◆ distanceUnit()

Qgis::RenderUnit QgsVectorFieldSymbolLayer::distanceUnit ( ) const

inline

Returns the units for the distance.

See also: setDistanceUnit()

Definition at line 114 of file qgsvectorfieldsymbollayer.h.

◆ drawPreviewIcon()

void QgsVectorFieldSymbolLayer::drawPreviewIcon	(	QgsSymbolRenderContext &	context,
		QSize	size
	)

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 300 of file qgsvectorfieldsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsVectorFieldSymbolLayer::hasDataDefinedProperties ( ) const

overridevirtual

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

Since: QGIS 3.4.5

Reimplemented from QgsSymbolLayer.

Definition at line 326 of file qgsvectorfieldsymbollayer.cpp.

◆ layerType()

QString QgsVectorFieldSymbolLayer::layerType ( ) const

inlineoverridevirtual

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 60 of file qgsvectorfieldsymbollayer.h.

◆ mapUnitScale()

QgsMapUnitScale QgsVectorFieldSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 53 of file qgsvectorfieldsymbollayer.cpp.

◆ outputUnit()

Qgis::RenderUnit QgsVectorFieldSymbolLayer::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 38 of file qgsvectorfieldsymbollayer.cpp.

◆ properties()

QVariantMap QgsVectorFieldSymbolLayer::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 261 of file qgsvectorfieldsymbollayer.cpp.

◆ renderPoint()

void QgsVectorFieldSymbolLayer::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 139 of file qgsvectorfieldsymbollayer.cpp.

◆ scale()

double QgsVectorFieldSymbolLayer::scale ( ) const

inline

Definition at line 89 of file qgsvectorfieldsymbollayer.h.

◆ setAngleOrientation()

void QgsVectorFieldSymbolLayer::setAngleOrientation ( AngleOrientation orientation )

inline

Definition at line 92 of file qgsvectorfieldsymbollayer.h.

◆ setAngleUnits()

void QgsVectorFieldSymbolLayer::setAngleUnits ( AngleUnits units )

inline

Definition at line 94 of file qgsvectorfieldsymbollayer.h.

◆ setColor()

void QgsVectorFieldSymbolLayer::setColor ( const QColor & color )

overridevirtual

Sets the "representative" color for the symbol layer.

Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally set the stroke color of the layer, while a fill symbol layer will set the "fill" color instead of stroke.

See also: color(); setStrokeColor(); setFillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 359 of file qgsvectorfieldsymbollayer.cpp.

◆ setDistanceMapUnitScale()

void QgsVectorFieldSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 116 of file qgsvectorfieldsymbollayer.h.

◆ setDistanceUnit()

void QgsVectorFieldSymbolLayer::setDistanceUnit ( Qgis::RenderUnit unit )

inline

Sets the units for the distance.

Parameters

unit	distance units

See also: distanceUnit()

Definition at line 108 of file qgsvectorfieldsymbollayer.h.

◆ setMapUnitScale()

void QgsVectorFieldSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 47 of file qgsvectorfieldsymbollayer.cpp.

◆ setOutputUnit()

void QgsVectorFieldSymbolLayer::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 30 of file qgsvectorfieldsymbollayer.cpp.

◆ setScale()

void QgsVectorFieldSymbolLayer::setScale ( double s )

inline

Definition at line 88 of file qgsvectorfieldsymbollayer.h.

◆ setSubSymbol()

bool QgsVectorFieldSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

Sets layer's subsymbol. takes ownership of the passed symbol.

Reimplemented from QgsSymbolLayer.

Definition at line 124 of file qgsvectorfieldsymbollayer.cpp.

◆ setVectorFieldType()

void QgsVectorFieldSymbolLayer::setVectorFieldType ( VectorFieldType type )

inline

Definition at line 90 of file qgsvectorfieldsymbollayer.h.

◆ setXAttribute()

void QgsVectorFieldSymbolLayer::setXAttribute ( const QString & attribute )

inline

Definition at line 84 of file qgsvectorfieldsymbollayer.h.

◆ setYAttribute()

void QgsVectorFieldSymbolLayer::setYAttribute ( const QString & attribute )

inline

Definition at line 86 of file qgsvectorfieldsymbollayer.h.

◆ startRender()

void QgsVectorFieldSymbolLayer::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 222 of file qgsvectorfieldsymbollayer.cpp.

◆ stopRender()

void QgsVectorFieldSymbolLayer::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 243 of file qgsvectorfieldsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsVectorFieldSymbolLayer::subSymbol ( )

overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 134 of file qgsvectorfieldsymbollayer.cpp.

◆ toSld()

void QgsVectorFieldSymbolLayer::toSld	(	QDomDocument &	doc,
		QDomElement &	element,
		const QVariantMap &	props
	)		const

overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 288 of file qgsvectorfieldsymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsVectorFieldSymbolLayer::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 308 of file qgsvectorfieldsymbollayer.cpp.

◆ usesMapUnits()

bool QgsVectorFieldSymbolLayer::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 281 of file qgsvectorfieldsymbollayer.cpp.

◆ vectorFieldType()

VectorFieldType QgsVectorFieldSymbolLayer::vectorFieldType ( ) const

inline

Definition at line 91 of file qgsvectorfieldsymbollayer.h.

◆ xAttribute()

QString QgsVectorFieldSymbolLayer::xAttribute ( ) const

inline

Definition at line 85 of file qgsvectorfieldsymbollayer.h.

◆ yAttribute()

QString QgsVectorFieldSymbolLayer::yAttribute ( ) const

inline

Definition at line 87 of file qgsvectorfieldsymbollayer.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ AngleOrientation

◆ AngleUnits

◆ VectorFieldType

Constructor & Destructor Documentation

◆ QgsVectorFieldSymbolLayer()

◆ ~QgsVectorFieldSymbolLayer()

Member Function Documentation

◆ angleOrientation()

◆ angleUnits()

◆ bounds()

◆ clone()

◆ color()

◆ create()

◆ createFromSld()

◆ distanceMapUnitScale()

◆ distanceUnit()

◆ drawPreviewIcon()

◆ hasDataDefinedProperties()

◆ layerType()

◆ mapUnitScale()

◆ outputUnit()

◆ properties()

◆ renderPoint()

◆ scale()

◆ setAngleOrientation()

◆ setAngleUnits()

◆ setColor()

◆ setDistanceMapUnitScale()

◆ setDistanceUnit()

◆ setMapUnitScale()

◆ setOutputUnit()

◆ setScale()

◆ setSubSymbol()

◆ setVectorFieldType()

◆ setXAttribute()

◆ setYAttribute()

◆ startRender()

◆ stopRender()

◆ subSymbol()

◆ toSld()

◆ usedAttributes()

◆ usesMapUnits()

◆ vectorFieldType()

◆ xAttribute()

◆ yAttribute()