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, PropertyHorizontalAnchor, PropertyVerticalAnchor, PropertyLayerEnabled, PropertyArrowWidth, PropertyArrowStartWidth, PropertyArrowHeadLength, PropertyArrowHeadThickness, PropertyArrowHeadType, PropertyArrowType }
	Data definable properties. More...

Public Member Functions
	QgsArrowSymbolLayer ()
	Simple constructor. More...

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

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

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

ArrowType	arrowType () const
	Gets the current arrow type. More...

double	arrowWidth () const
	Gets current arrow width. More...

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

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

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

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

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

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

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

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

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

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

HeadType	headType () const
	Gets the current head type. More...

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

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

QString	layerType () const override
	Returns a string that represents this layer type. 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	renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context) override

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

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

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

void	setArrowType (ArrowType type)
	Sets the arrow type. More...

void	setArrowWidth (double width)
	Sets the arrow width. More...

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

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

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

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

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

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

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

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

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

void	setHeadType (HeadType type)
	Sets the head type. More...

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

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

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

void	startRender (QgsSymbolRenderContext &context) override

void	stopRender (QgsSymbolRenderContext &context) override

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

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

Public Member Functions inherited from QgsLineSymbolLayer
void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

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

QgsMapUnitScale	mapUnitScale () const override

double	offset () const

const QgsMapUnitScale &	offsetMapUnitScale () const

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

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

virtual void	renderPolygonStroke (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &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. More...

void	setMapUnitScale (const QgsMapUnitScale &scale) override

void	setOffset (double offset)

void	setOffsetMapUnitScale (const QgsMapUnitScale &scale)

void	setOffsetUnit (QgsUnitTypes::RenderUnit unit)
	Sets the units for the line's offset. More...

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

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

virtual void	setWidth (double width)

void	setWidthMapUnitScale (const QgsMapUnitScale &scale)

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

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

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

const QgsMapUnitScale &	widthMapUnitScale () const

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

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

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

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

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)

virtual void	setStrokeColor (const QColor &color)
	Set stroke color. More...

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

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

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

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

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

Protected Attributes inherited from QgsLineSymbolLayer
double	mOffset = 0

QgsMapUnitScale	mOffsetMapUnitScale

QgsUnitTypes::RenderUnit	mOffsetUnit = QgsUnitTypes::RenderMillimeters

RenderRingFilter	mRingFilter = AllRings

double	mWidth = 0

QgsMapUnitScale	mWidthMapUnitScale

QgsUnitTypes::RenderUnit	mWidthUnit = QgsUnitTypes::RenderMillimeters

Protected Attributes inherited from QgsSymbolLayer
QColor	mColor

QgsPropertyCollection	mDataDefinedProperties

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

QgsFields	mFields

bool	mLocked

QgsPaintEffect *	mPaintEffect = nullptr

int	mRenderingPass

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

Line symbol layer used for representing lines as arrows.

Since: QGIS 2.16

Definition at line 31 of file qgsarrowsymbollayer.h.

Member Enumeration Documentation

enum QgsArrowSymbolLayer::ArrowType

Possible arrow types.

Enumerator
ArrowPlain
ArrowLeftHalf
ArrowRightHalf

Definition at line 128 of file qgsarrowsymbollayer.h.

enum QgsArrowSymbolLayer::HeadType

Possible head types.

Enumerator
HeadSingle
HeadReversed
HeadDouble

Definition at line 115 of file qgsarrowsymbollayer.h.

Constructor & Destructor Documentation

QgsArrowSymbolLayer::QgsArrowSymbolLayer ( )

Simple constructor.

Definition at line 19 of file qgsarrowsymbollayer.cpp.

Member Function Documentation

double QgsArrowSymbolLayer::arrowStartWidth ( ) const

inline

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

Definition at line 66 of file qgsarrowsymbollayer.h.

QgsUnitTypes::RenderUnit QgsArrowSymbolLayer::arrowStartWidthUnit ( ) const

inline

Gets the unit for the arrow start width.

Definition at line 70 of file qgsarrowsymbollayer.h.

QgsMapUnitScale QgsArrowSymbolLayer::arrowStartWidthUnitScale ( ) const

inline

Gets the scale for the arrow start width.

Definition at line 74 of file qgsarrowsymbollayer.h.

ArrowType QgsArrowSymbolLayer::arrowType ( ) const

inline

Gets the current arrow type.

Definition at line 136 of file qgsarrowsymbollayer.h.

double QgsArrowSymbolLayer::arrowWidth ( ) const

inline

Gets current arrow width.

Definition at line 53 of file qgsarrowsymbollayer.h.

QgsUnitTypes::RenderUnit QgsArrowSymbolLayer::arrowWidthUnit ( ) const

inline

Gets the unit for the arrow width.

Definition at line 57 of file qgsarrowsymbollayer.h.

QgsMapUnitScale QgsArrowSymbolLayer::arrowWidthUnitScale ( ) const

inline

Gets the scale for the arrow width.

Definition at line 61 of file qgsarrowsymbollayer.h.

QgsArrowSymbolLayer * QgsArrowSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 110 of file qgsarrowsymbollayer.cpp.

QColor QgsArrowSymbolLayer::color ( ) const

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 811 of file qgsarrowsymbollayer.cpp.

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

static

Create a new QgsArrowSymbolLayer.

Parameters

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

Returns: A new QgsArrowSymbolLayer

Definition at line 39 of file qgsarrowsymbollayer.cpp.

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 168 of file qgsarrowsymbollayer.cpp.

double QgsArrowSymbolLayer::headLength ( ) const

inline

Gets the current arrow head length.

Definition at line 79 of file qgsarrowsymbollayer.h.

QgsUnitTypes::RenderUnit QgsArrowSymbolLayer::headLengthUnit ( ) const

inline

Gets the unit for the head length.

Definition at line 83 of file qgsarrowsymbollayer.h.

QgsMapUnitScale QgsArrowSymbolLayer::headLengthUnitScale ( ) const

inline

Gets the scale for the head length.

Definition at line 87 of file qgsarrowsymbollayer.h.

double QgsArrowSymbolLayer::headThickness ( ) const

inline

Gets the current arrow head height.

Definition at line 92 of file qgsarrowsymbollayer.h.

QgsUnitTypes::RenderUnit QgsArrowSymbolLayer::headThicknessUnit ( ) const

inline

Gets the unit for the head height.

Definition at line 96 of file qgsarrowsymbollayer.h.

QgsMapUnitScale QgsArrowSymbolLayer::headThicknessUnitScale ( ) const

inline

Gets the scale for the head height.

Definition at line 100 of file qgsarrowsymbollayer.h.

HeadType QgsArrowSymbolLayer::headType ( ) const

inline

Gets the current head type.

Definition at line 123 of file qgsarrowsymbollayer.h.

bool QgsArrowSymbolLayer::isCurved ( ) const

inline

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

Definition at line 105 of file qgsarrowsymbollayer.h.

bool QgsArrowSymbolLayer::isRepeated ( ) const

inline

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

Definition at line 110 of file qgsarrowsymbollayer.h.

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 119 of file qgsarrowsymbollayer.cpp.

QgsStringMap 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 124 of file qgsarrowsymbollayer.cpp.

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

overridevirtual

Implements QgsLineSymbolLayer.

Definition at line 684 of file qgsarrowsymbollayer.cpp.

void QgsArrowSymbolLayer::setArrowStartWidth ( double width )

inline

Sets the arrow start width.

Definition at line 68 of file qgsarrowsymbollayer.h.

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

inline

Sets the unit for the arrow start width.

Definition at line 72 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setArrowStartWidthUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the arrow start width.

Definition at line 76 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setArrowType ( ArrowType type )

inline

Sets the arrow type.

Definition at line 138 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setArrowWidth ( double width )

inline

Sets the arrow width.

Definition at line 55 of file qgsarrowsymbollayer.h.

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

inline

Sets the unit for the arrow width.

Definition at line 59 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setArrowWidthUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the arrow width.

Definition at line 63 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setColor ( const QColor & color )

overridevirtual

The fill color.

Reimplemented from QgsSymbolLayer.

Definition at line 803 of file qgsarrowsymbollayer.cpp.

void QgsArrowSymbolLayer::setHeadLength ( double length )

inline

Sets the arrow head length.

Definition at line 81 of file qgsarrowsymbollayer.h.

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

inline

Sets the unit for the head length.

Definition at line 85 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setHeadLengthUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the head length.

Definition at line 89 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setHeadThickness ( double thickness )

inline

Sets the arrow head height.

Definition at line 94 of file qgsarrowsymbollayer.h.

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

inline

Sets the unit for the head height.

Definition at line 98 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setHeadThicknessUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the scale for the head height.

Definition at line 102 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setHeadType ( HeadType type )

inline

Sets the head type.

Definition at line 125 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setIsCurved ( bool isCurved )

inline

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

Definition at line 107 of file qgsarrowsymbollayer.h.

void QgsArrowSymbolLayer::setIsRepeated ( bool isRepeated )

inline

Sets whether the arrow is repeated along the line.

Definition at line 112 of file qgsarrowsymbollayer.h.

bool QgsArrowSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 28 of file qgsarrowsymbollayer.cpp.

void QgsArrowSymbolLayer::startRender ( QgsSymbolRenderContext & context )

overridevirtual

Implements QgsSymbolLayer.

Definition at line 177 of file qgsarrowsymbollayer.cpp.

void QgsArrowSymbolLayer::stopRender ( QgsSymbolRenderContext & context )

overridevirtual

Implements QgsSymbolLayer.

Definition at line 191 of file qgsarrowsymbollayer.cpp.

QgsSymbol* QgsArrowSymbolLayer::subSymbol ( )

inlineoverridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 47 of file qgsarrowsymbollayer.h.

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 159 of file qgsarrowsymbollayer.cpp.

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

/build/qgis-3.4.15+24xenial/src/core/symbology/qgsarrowsymbollayer.h
/build/qgis-3.4.15+24xenial/src/core/symbology/qgsarrowsymbollayer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation