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

#include <qgsvectorfieldsymbollayer.h>

Inheritance diagram for QgsVectorFieldSymbolLayer:

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	Property { PropertySize = 0, PropertyAngle, PropertyName, PropertyFillColor, PropertyStrokeColor, PropertyStrokeWidth, PropertyStrokeStyle, PropertyOffset, PropertyCharacter, PropertyWidth, PropertyHeight, PropertyPreserveAspectRatio, PropertyFillStyle, PropertyJoinStyle, PropertySecondaryColor, PropertyLineAngle, PropertyLineDistance, PropertyGradientType, PropertyCoordinateMode, PropertyGradientSpread, PropertyGradientReference1X, PropertyGradientReference1Y, PropertyGradientReference2X, PropertyGradientReference2Y, PropertyGradientReference1IsCentroid, PropertyGradientReference2IsCentroid, PropertyBlurRadius, PropertyShapeburstUseWholeShape, PropertyShapeburstMaxDistance, PropertyShapeburstIgnoreRings, PropertyFile, PropertyDistanceX, PropertyDistanceY, PropertyDisplacementX, PropertyDisplacementY, PropertyOpacity, PropertyCustomDash, PropertyCapStyle, PropertyPlacement, PropertyInterval, PropertyOffsetAlongLine, PropertyAverageAngleLength, PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled, PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness, PropertyArrowHeadType, PropertyArrowType, PropertyOffsetX, PropertyOffsetY }
	Data definable properties. More...

Public Member Functions
	QgsVectorFieldSymbolLayer ()

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

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

QColor	color () const override
	The fill color. More...

const QgsMapUnitScale &	distanceMapUnitScale () const

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

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

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

QgsMapUnitScale	mapUnitScale () const override

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

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

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

double	scale () const

void	setAngleOrientation (AngleOrientation orientation)

void	setAngleUnits (AngleUnits units)

void	setColor (const QColor &color) override
	The fill color. More...

void	setDistanceMapUnitScale (const QgsMapUnitScale &scale)

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

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOutputUnit (QgsUnitTypes::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer. More...

void	setScale (double s)

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

void	setVectorFieldType (VectorFieldType type)

void	setXAttribute (const QString &attribute)

void	setYAttribute (const QString &attribute)

void	startRender (QgsSymbolRenderContext &context) override

void	stopRender (QgsSymbolRenderContext &context) override

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

void	toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override

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

VectorFieldType	vectorFieldType () const

QString	xAttribute () const

QString	yAttribute () const

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

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

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 QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale for the symbol's offset. More...

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

QgsMarkerSymbolLayer &	operator= (const QgsMarkerSymbolLayer &other)=delete
	QgsMarkerSymbolLayer cannot be copied. More...

QgsSymbol::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	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 (QgsUnitTypes::RenderUnit unit)
	Sets the units for the symbol's offset. More...

void	setScaleMethod (QgsSymbol::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 (QgsUnitTypes::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 QgsMapUnitScale &	sizeMapUnitScale () const
	Returns the map unit scale for the symbol's size. More...

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

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

virtual void	writeSldMarker (QDomDocument &doc, QDomElement &element, const QgsStringMap &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 ()

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

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

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 (QgsUnitTypes::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	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
	Gets fill color. More...

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

bool	isLocked () const

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete
	QgsSymbolLayer cannot be copied. More...

QgsPaintEffect *	paintEffect () 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...

int	renderingPass () const
	Specifies the rendering pass in which this symbol layer should be rendered. 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)
	Set fill color. More...

void	setLocked (bool locked)

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)
	Set stroke color. More...

virtual QColor	strokeColor () const
	Gets stroke color. More...

QgsSymbol::SymbolType	type () const

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

Static Public Member Functions
static QgsSymbolLayer *	create (const QgsStringMap &properties=QgsStringMap())

static QgsSymbolLayer *	createFromSld (QDomElement &element)

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

Additional Inherited Members
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, QgsUnitTypes::RenderUnit widthUnit, QgsUnitTypes::RenderUnit heightUnit, double &offsetX, double &offsetY, const QgsMapUnitScale &widthMapUnitScale, const QgsMapUnitScale &heightMapUnitScale) const

Protected Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false)

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

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

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

Static Protected Member Functions inherited from QgsMarkerSymbolLayer
static QPointF	_rotatedOffset (QPointF offset, double angle)
	Adjusts a marker offset to account for rotation. More...

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

QgsUnitTypes::RenderUnit	mOffsetUnit = QgsUnitTypes::RenderMillimeters
	Offset units. More...

QgsSymbol::ScaleMethod	mScaleMethod = QgsSymbol::ScaleDiameter
	Marker size scaling method. More...

double	mSize = 2.0
	Marker size. More...

QgsMapUnitScale	mSizeMapUnitScale
	Marker size map unit scale. More...

QgsUnitTypes::RenderUnit	mSizeUnit = QgsUnitTypes::RenderMillimeters
	Marker size unit. More...

VerticalAnchorPoint	mVerticalAnchorPoint = VCenter
	Vertical anchor point. More...

Protected Attributes inherited from QgsSymbolLayer
QColor	mColor

QgsPropertyCollection	mDataDefinedProperties

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

QgsFields	mFields

bool	mLocked = false

std::unique_ptr< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

QgsSymbol::SymbolType	mType

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

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

Definition at line 28 of file qgsvectorfieldsymbollayer.h.

Member Enumeration Documentation

◆ AngleOrientation

enum QgsVectorFieldSymbolLayer::AngleOrientation

Enumerator
ClockwiseFromNorth
CounterclockwiseFromEast

Definition at line 38 of file qgsvectorfieldsymbollayer.h.

◆ AngleUnits

enum QgsVectorFieldSymbolLayer::AngleUnits

Enumerator
Degrees
Radians

Definition at line 44 of file qgsvectorfieldsymbollayer.h.

◆ VectorFieldType

enum QgsVectorFieldSymbolLayer::VectorFieldType

Enumerator
Cartesian
Polar
Height

Definition at line 31 of file qgsvectorfieldsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsVectorFieldSymbolLayer()

QgsVectorFieldSymbolLayer::QgsVectorFieldSymbolLayer ( )

Definition at line 23 of file qgsvectorfieldsymbollayer.cpp.

Member Function Documentation

◆ angleOrientation()

AngleOrientation QgsVectorFieldSymbolLayer::angleOrientation ( ) const

inline

Definition at line 87 of file qgsvectorfieldsymbollayer.h.

◆ angleUnits()

AngleUnits QgsVectorFieldSymbolLayer::angleUnits ( ) const

inline

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

Since: QGIS 2.14

Implements QgsMarkerSymbolLayer.

Definition at line 114 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 219 of file qgsvectorfieldsymbollayer.cpp.

◆ color()

QColor QgsVectorFieldSymbolLayer::color ( ) const

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 328 of file qgsvectorfieldsymbollayer.cpp.

◆ create()

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

static

Definition at line 58 of file qgsvectorfieldsymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsVectorFieldSymbolLayer::createFromSld ( QDomElement & element )

static

Definition at line 255 of file qgsvectorfieldsymbollayer.cpp.

◆ distanceMapUnitScale()

const QgsMapUnitScale& QgsVectorFieldSymbolLayer::distanceMapUnitScale ( ) const

inline

Definition at line 111 of file qgsvectorfieldsymbollayer.h.

◆ distanceUnit()

QgsUnitTypes::RenderUnit QgsVectorFieldSymbolLayer::distanceUnit ( ) const

inline

Returns the units for the distance.

See also: setDistanceUnit()

Definition at line 108 of file qgsvectorfieldsymbollayer.h.

◆ drawPreviewIcon()

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

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 261 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 287 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 55 of file qgsvectorfieldsymbollayer.h.

◆ mapUnitScale()

QgsMapUnitScale QgsVectorFieldSymbolLayer::mapUnitScale ( ) const

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 49 of file qgsvectorfieldsymbollayer.cpp.

◆ outputUnit()

QgsUnitTypes::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 34 of file qgsvectorfieldsymbollayer.cpp.

◆ properties()

QgsStringMap 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 229 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 130 of file qgsvectorfieldsymbollayer.cpp.

◆ scale()

double QgsVectorFieldSymbolLayer::scale ( ) const

inline

Definition at line 83 of file qgsvectorfieldsymbollayer.h.

◆ setAngleOrientation()

void QgsVectorFieldSymbolLayer::setAngleOrientation ( AngleOrientation orientation )

inline

Definition at line 86 of file qgsvectorfieldsymbollayer.h.

◆ setAngleUnits()

void QgsVectorFieldSymbolLayer::setAngleUnits ( AngleUnits units )

inline

Definition at line 88 of file qgsvectorfieldsymbollayer.h.

◆ setColor()

void QgsVectorFieldSymbolLayer::setColor ( const QColor & color )

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 320 of file qgsvectorfieldsymbollayer.cpp.

◆ setDistanceMapUnitScale()

void QgsVectorFieldSymbolLayer::setDistanceMapUnitScale ( const QgsMapUnitScale & scale )

inline

Definition at line 110 of file qgsvectorfieldsymbollayer.h.

◆ setDistanceUnit()

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

inline

Sets the units for the distance.

Parameters

unit	distance units

See also: distanceUnit()

Definition at line 102 of file qgsvectorfieldsymbollayer.h.

◆ setMapUnitScale()

void QgsVectorFieldSymbolLayer::setMapUnitScale ( const QgsMapUnitScale & scale )

overridevirtual

Reimplemented from QgsMarkerSymbolLayer.

Definition at line 43 of file qgsvectorfieldsymbollayer.cpp.

◆ setOutputUnit()

void QgsVectorFieldSymbolLayer::setOutputUnit ( QgsUnitTypes::RenderUnit unit )

overridevirtual

Sets the units to use for sizes and widths within the symbol layer.

Individual symbol layer subclasses will interpret this in different ways, 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