Line symbol layer used for representing lines as arrows. More...

#include <qgsarrowsymbollayer.h>

Inheritance diagram for QgsArrowSymbolLayer:

Public Types
enum	ArrowType { ArrowPlain , ArrowLeftHalf , ArrowRightHalf }
	Possible arrow types. More...

enum	HeadType { HeadSingle , HeadReversed , HeadDouble }
	Possible head types. More...

Public Types inherited from QgsLineSymbolLayer
enum	RenderRingFilter { AllRings , ExteriorRingOnly , InteriorRingsOnly }
	Options for filtering rings when the line symbol layer is being used to render a polygon's rings. 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 , PropertyPointCount , PropertyRandomSeed , PropertyClipPoints , PropertyDensityArea , PropertyFontFamily , PropertyFontStyle , PropertyDashPatternOffset , PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue , PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX , PropertyRandomOffsetY , PropertyLineClipping }
	Data definable properties. More...

Public Member Functions
	QgsArrowSymbolLayer ()
	Simple constructor.

	~QgsArrowSymbolLayer () override

double	arrowStartWidth () const
	Gets current arrow start width. Only meaningful for single headed arrows.

Qgis::RenderUnit	arrowStartWidthUnit () const
	Gets the unit for the arrow start width.

QgsMapUnitScale	arrowStartWidthUnitScale () const
	Gets the scale for the arrow start width.

ArrowType	arrowType () const
	Gets the current arrow type.

double	arrowWidth () const
	Gets current arrow width.

Qgis::RenderUnit	arrowWidthUnit () const
	Gets the unit for the arrow width.

QgsMapUnitScale	arrowWidthUnitScale () const
	Gets the scale for the arrow width.

bool	canCauseArtifactsBetweenAdjacentTiles () const override
	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.

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

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

double	headLength () const
	Gets the current arrow head length.

Qgis::RenderUnit	headLengthUnit () const
	Gets the unit for the head length.

QgsMapUnitScale	headLengthUnitScale () const
	Gets the scale for the head length.

double	headThickness () const
	Gets the current arrow head height.

Qgis::RenderUnit	headThicknessUnit () const
	Gets the unit for the head height.

QgsMapUnitScale	headThicknessUnitScale () const
	Gets the scale for the head height.

HeadType	headType () const
	Gets the current head type.

bool	isCurved () const
	Returns whether it is a curved arrow or a straight one.

bool	isRepeated () const
	Returns whether the arrow is repeated along the line or not.

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	renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context) override
	Renders the line symbol layer along the line joining points, using the given render context.

void	setArrowStartWidth (double width)
	Sets the arrow start width.

void	setArrowStartWidthUnit (Qgis::RenderUnit unit)
	Sets the unit for the arrow start width.

void	setArrowStartWidthUnitScale (const QgsMapUnitScale &scale)
	Sets the scale for the arrow start width.

void	setArrowType (ArrowType type)
	Sets the arrow type.

void	setArrowWidth (double width)
	Sets the arrow width.

void	setArrowWidthUnit (Qgis::RenderUnit unit)
	Sets the unit for the arrow width.

void	setArrowWidthUnitScale (const QgsMapUnitScale &scale)
	Sets the scale for the arrow width.

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

void	setHeadLength (double length)
	Sets the arrow head length.

void	setHeadLengthUnit (Qgis::RenderUnit unit)
	Sets the unit for the head length.

void	setHeadLengthUnitScale (const QgsMapUnitScale &scale)
	Sets the scale for the head length.

void	setHeadThickness (double thickness)
	Sets the arrow head height.

void	setHeadThicknessUnit (Qgis::RenderUnit unit)
	Sets the unit for the head height.

void	setHeadThicknessUnitScale (const QgsMapUnitScale &scale)
	Sets the scale for the head height.

void	setHeadType (HeadType type)
	Sets the head type.

void	setIsCurved (bool isCurved)
	Sets whether it is a curved arrow or a straight one.

void	setIsRepeated (bool isRepeated)
	Sets whether the arrow is repeated along the line.

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

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

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.

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.

Public Member Functions inherited from QgsLineSymbolLayer
	QgsLineSymbolLayer (const QgsLineSymbolLayer &other)=delete
	QgsLineSymbolLayer cannot be copied.

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

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

QgsMapUnitScale	mapUnitScale () const override

double	offset () const
	Returns the line's offset.

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

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

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

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

virtual void	renderPolygonStroke (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)
	Renders the line symbol layer along the outline of polygon, using the given render context.

RenderRingFilter	ringFilter () const
	Returns the line symbol layer's ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon's rings.

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOffset (double offset)
	Sets the line's offset.

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

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

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

void	setRingFilter (QgsLineSymbolLayer::RenderRingFilter filter)
	Sets the line symbol layer's ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon's rings.

virtual void	setWidth (double width)
	Sets the width of the line symbol layer.

void	setWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the line's width.

virtual double	width () const
	Returns the estimated width for the line symbol layer.

virtual double	width (const QgsRenderContext &context) const
	Returns the line symbol layer width, in painter units.

const QgsMapUnitScale &	widthMapUnitScale () const

Qgis::RenderUnit	widthUnit () const
	Returns the units for the line's width.

Public Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete
	QgsSymbolLayer cannot be copied.

virtual	~QgsSymbolLayer ()

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 double	dxfAngle (QgsSymbolRenderContext &context) const
	Gets angle.

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	dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
	Gets marker size.

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.

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
	QgsSymbolLayer cannot be copied.

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.

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

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())
	Create a new QgsArrowSymbolLayer.

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 QgsLineSymbolLayer
	QgsLineSymbolLayer (bool locked=false)

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	installMasks (QgsRenderContext &context, bool recursive)
	When rendering, install masks on context painter if recursive is `true` masks are installed recursively for all children symbol layers.

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 inherited from QgsLineSymbolLayer
double	mOffset = 0

QgsMapUnitScale	mOffsetMapUnitScale

Qgis::RenderUnit	mOffsetUnit = Qgis::RenderUnit::Millimeters

RenderRingFilter	mRingFilter = AllRings

double	mWidth = 0

QgsMapUnitScale	mWidthMapUnitScale

Qgis::RenderUnit	mWidthUnit = Qgis::RenderUnit::Millimeters

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

Line symbol layer used for representing lines as arrows.

Since: QGIS 2.16

Definition at line 33 of file qgsarrowsymbollayer.h.

Member Enumeration Documentation

◆ ArrowType

enum QgsArrowSymbolLayer::ArrowType

Possible arrow types.

Enumerator
ArrowPlain
ArrowLeftHalf
ArrowRightHalf

Definition at line 133 of file qgsarrowsymbollayer.h.

◆ HeadType

enum QgsArrowSymbolLayer::HeadType

Possible head types.

Enumerator
HeadSingle
HeadReversed
HeadDouble

Definition at line 120 of file qgsarrowsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsArrowSymbolLayer()

QgsArrowSymbolLayer::QgsArrowSymbolLayer ( )

Simple constructor.

Definition at line 22 of file qgsarrowsymbollayer.cpp.

◆ ~QgsArrowSymbolLayer()

QgsArrowSymbolLayer::~QgsArrowSymbolLayer ( )

overridedefault

Member Function Documentation

◆ arrowStartWidth()

double QgsArrowSymbolLayer::arrowStartWidth ( ) const

inline

Gets current arrow start width. Only meaningful for single headed arrows.

Definition at line 71 of file qgsarrowsymbollayer.h.

◆ arrowStartWidthUnit()

Qgis::RenderUnit QgsArrowSymbolLayer::arrowStartWidthUnit ( ) const

inline

Gets the unit for the arrow start width.

Definition at line 75 of file qgsarrowsymbollayer.h.

◆ arrowStartWidthUnitScale()

QgsMapUnitScale QgsArrowSymbolLayer::arrowStartWidthUnitScale ( ) const

inline

Gets the scale for the arrow start width.

Definition at line 79 of file qgsarrowsymbollayer.h.

◆ arrowType()

ArrowType QgsArrowSymbolLayer::arrowType ( ) const

inline

Gets the current arrow type.

Definition at line 141 of file qgsarrowsymbollayer.h.

◆ arrowWidth()

double QgsArrowSymbolLayer::arrowWidth ( ) const

inline

Gets current arrow width.

Definition at line 58 of file qgsarrowsymbollayer.h.

◆ arrowWidthUnit()

Qgis::RenderUnit QgsArrowSymbolLayer::arrowWidthUnit ( ) const

inline

Gets the unit for the arrow width.

Definition at line 62 of file qgsarrowsymbollayer.h.

◆ arrowWidthUnitScale()

QgsMapUnitScale QgsArrowSymbolLayer::arrowWidthUnitScale ( ) const

inline

Gets the scale for the arrow width.

Definition at line 66 of file qgsarrowsymbollayer.h.

◆ canCauseArtifactsBetweenAdjacentTiles()

bool QgsArrowSymbolLayer::canCauseArtifactsBetweenAdjacentTiles ( ) const

overridevirtual

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.

The default implementation returns false.

Since: QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 876 of file qgsarrowsymbollayer.cpp.

◆ clone()

QgsArrowSymbolLayer * QgsArrowSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 115 of file qgsarrowsymbollayer.cpp.

◆ color()

QColor QgsArrowSymbolLayer::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 871 of file qgsarrowsymbollayer.cpp.

◆ create()

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

static

Create a new QgsArrowSymbolLayer.

Parameters

properties A property map to deserialize saved information from properties()

Returns: A new QgsArrowSymbolLayer

Definition at line 44 of file qgsarrowsymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsArrowSymbolLayer::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 178 of file qgsarrowsymbollayer.cpp.

◆ headLength()

double QgsArrowSymbolLayer::headLength ( ) const

inline

Gets the current arrow head length.

Definition at line 84 of file qgsarrowsymbollayer.h.

◆ headLengthUnit()

Qgis::RenderUnit QgsArrowSymbolLayer::headLengthUnit ( ) const

inline

Gets the unit for the head length.

Definition at line 88 of file qgsarrowsymbollayer.h.

◆ headLengthUnitScale()

QgsMapUnitScale QgsArrowSymbolLayer::headLengthUnitScale ( ) const

inline

Gets the scale for the head length.

Definition at line 92 of file qgsarrowsymbollayer.h.

◆ headThickness()

double QgsArrowSymbolLayer::headThickness ( ) const

inline

Gets the current arrow head height.

Definition at line 97 of file qgsarrowsymbollayer.h.

◆ headThicknessUnit()

Qgis::RenderUnit QgsArrowSymbolLayer::headThicknessUnit ( ) const

inline

Gets the unit for the head height.

Definition at line 101 of file qgsarrowsymbollayer.h.

◆ headThicknessUnitScale()

QgsMapUnitScale QgsArrowSymbolLayer::headThicknessUnitScale ( ) const

inline

Gets the scale for the head height.

Definition at line 105 of file qgsarrowsymbollayer.h.

◆ headType()

HeadType QgsArrowSymbolLayer::headType ( ) const

inline

Gets the current head type.

Definition at line 128 of file qgsarrowsymbollayer.h.

◆ isCurved()

bool QgsArrowSymbolLayer::isCurved ( ) const

inline

Returns whether it is a curved arrow or a straight one.

Definition at line 110 of file qgsarrowsymbollayer.h.

◆ isRepeated()

bool QgsArrowSymbolLayer::isRepeated ( ) const

inline

Returns whether the arrow is repeated along the line or not.

Definition at line 115 of file qgsarrowsymbollayer.h.

◆ layerType()

QString QgsArrowSymbolLayer::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 129 of file qgsarrowsymbollayer.cpp.

◆ properties()

QVariantMap QgsArrowSymbolLayer::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 134 of file qgsarrowsymbollayer.cpp.

◆ renderPolyline()

void QgsArrowSymbolLayer::renderPolyline	(	const QPolygonF &	points,
		QgsSymbolRenderContext &	context
	)

overridevirtual

Renders the line symbol layer along the line joining points, using the given render context.

See also: renderPolygonStroke()

Implements QgsLineSymbolLayer.

Definition at line 731 of file qgsarrowsymbollayer.cpp.

◆ setArrowStartWidth()

void QgsArrowSymbolLayer::setArrowStartWidth ( double width )

inline

Sets the arrow start width.

Definition at line 73 of file qgsarrowsymbollayer.h.

◆ setArrowStartWidthUnit()

void QgsArrowSymbolLayer::setArrowStartWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the arrow start width.

Definition at line 77 of file qgsarrowsymbollayer.h.

◆ setArrowStartWidthUnitScale()

void QgsArrowSymbolLayer::setArrowStartWidthUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the arrow start width.

Definition at line 81 of file qgsarrowsymbollayer.h.

◆ setArrowType()

void QgsArrowSymbolLayer::setArrowType ( ArrowType type )

inline

Sets the arrow type.

Definition at line 143 of file qgsarrowsymbollayer.h.

◆ setArrowWidth()

void QgsArrowSymbolLayer::setArrowWidth ( double width )

inline

Sets the arrow width.

Definition at line 60 of file qgsarrowsymbollayer.h.

◆ setArrowWidthUnit()

void QgsArrowSymbolLayer::setArrowWidthUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the arrow width.

Definition at line 64 of file qgsarrowsymbollayer.h.

◆ setArrowWidthUnitScale()

void QgsArrowSymbolLayer::setArrowWidthUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the arrow width.

Definition at line 68 of file qgsarrowsymbollayer.h.

◆ setColor()

void QgsArrowSymbolLayer::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 863 of file qgsarrowsymbollayer.cpp.

◆ setHeadLength()

void QgsArrowSymbolLayer::setHeadLength ( double length )

inline

Sets the arrow head length.

Definition at line 86 of file qgsarrowsymbollayer.h.

◆ setHeadLengthUnit()

void QgsArrowSymbolLayer::setHeadLengthUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the head length.

Definition at line 90 of file qgsarrowsymbollayer.h.

◆ setHeadLengthUnitScale()

void QgsArrowSymbolLayer::setHeadLengthUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the head length.

Definition at line 94 of file qgsarrowsymbollayer.h.

◆ setHeadThickness()

void QgsArrowSymbolLayer::setHeadThickness ( double thickness )

inline

Sets the arrow head height.

Definition at line 99 of file qgsarrowsymbollayer.h.

◆ setHeadThicknessUnit()

void QgsArrowSymbolLayer::setHeadThicknessUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the head height.

Definition at line 103 of file qgsarrowsymbollayer.h.

◆ setHeadThicknessUnitScale()

void QgsArrowSymbolLayer::setHeadThicknessUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the head height.

Definition at line 107 of file qgsarrowsymbollayer.h.

◆ setHeadType()

void QgsArrowSymbolLayer::setHeadType ( HeadType type )

inline

Sets the head type.

Definition at line 130 of file qgsarrowsymbollayer.h.

◆ setIsCurved()

void QgsArrowSymbolLayer::setIsCurved ( bool isCurved )

inline

Sets whether it is a curved arrow or a straight one.

Definition at line 112 of file qgsarrowsymbollayer.h.

◆ setIsRepeated()

void QgsArrowSymbolLayer::setIsRepeated ( bool isRepeated )

inline

Sets whether the arrow is repeated along the line.

Definition at line 117 of file qgsarrowsymbollayer.h.

◆ setOutputUnit()

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

Definition at line 197 of file qgsarrowsymbollayer.cpp.

◆ setSubSymbol()

bool QgsArrowSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 33 of file qgsarrowsymbollayer.cpp.

◆ startRender()

void QgsArrowSymbolLayer::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 206 of file qgsarrowsymbollayer.cpp.

◆ stopRender()

void QgsArrowSymbolLayer::stopRender ( QgsSymbolRenderContext & context )

overridevirtual

Called after a set of rendering operations has finished on the supplied render context.

This is always preceded by a call to startRender() before all rendering operations are commenced.

Subclasses can use this method to cleanup after a set of rendering operations.

See also: startRender(); stopFeatureRender()

Implements QgsSymbolLayer.

Definition at line 220 of file qgsarrowsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsArrowSymbolLayer::subSymbol ( )

overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 124 of file qgsarrowsymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsArrowSymbolLayer::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 169 of file qgsarrowsymbollayer.cpp.

◆ usesMapUnits()

bool QgsArrowSymbolLayer::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 187 of file qgsarrowsymbollayer.cpp.

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

/build/qgis-3.34.0+99sid/src/core/symbology/qgsarrowsymbollayer.h
/build/qgis-3.34.0+99sid/src/core/symbology/qgsarrowsymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ ArrowType

◆ HeadType

Constructor & Destructor Documentation

◆ QgsArrowSymbolLayer()

◆ ~QgsArrowSymbolLayer()

Member Function Documentation

◆ arrowStartWidth()

◆ arrowStartWidthUnit()

◆ arrowStartWidthUnitScale()

◆ arrowType()

◆ arrowWidth()

◆ arrowWidthUnit()

◆ arrowWidthUnitScale()

◆ canCauseArtifactsBetweenAdjacentTiles()

◆ clone()

◆ color()

◆ create()

◆ hasDataDefinedProperties()

◆ headLength()

◆ headLengthUnit()

◆ headLengthUnitScale()

◆ headThickness()

◆ headThicknessUnit()

◆ headThicknessUnitScale()

◆ headType()

◆ isCurved()

◆ isRepeated()

◆ layerType()

◆ properties()

◆ renderPolyline()

◆ setArrowStartWidth()

◆ setArrowStartWidthUnit()

◆ setArrowStartWidthUnitScale()

◆ setArrowType()

◆ setArrowWidth()

◆ setArrowWidthUnit()

◆ setArrowWidthUnitScale()

◆ setColor()

◆ setHeadLength()

◆ setHeadLengthUnit()

◆ setHeadLengthUnitScale()

◆ setHeadThickness()

◆ setHeadThicknessUnit()

◆ setHeadThicknessUnitScale()

◆ setHeadType()

◆ setIsCurved()

◆ setIsRepeated()

◆ setOutputUnit()

◆ setSubSymbol()

◆ startRender()

◆ stopRender()

◆ subSymbol()

◆ usedAttributes()

◆ usesMapUnits()