QGIS API Documentation 3.28.0-Firenze (ed3ad0430f)
Public Types | Public Member Functions | Static Public Member Functions | List of all members
QgsArrowSymbolLayer Class Reference

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

#include <qgsarrowsymbollayer.h>

Inheritance diagram for QgsArrowSymbolLayer:
Inheritance graph
[legend]

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. More...
 
 ~QgsArrowSymbolLayer () override
 
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...
 
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. More...
 
QgsArrowSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
QColor color () const override
 Returns the "representative" color of the symbol layer. 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...
 
QVariantMap 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
 Renders the line symbol layer along the line joining points, using the given render context. More...
 
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
 Sets the "representative" color for the symbol layer. 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...
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
void startRender (QgsSymbolRenderContext &context) override
 Called before a set of rendering operations commences on the supplied render context. More...
 
void stopRender (QgsSymbolRenderContext &context) override
 Called after a set of rendering operations has finished on the supplied render context. More...
 
QgsSymbolsubSymbol () 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...
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
- Public Member Functions inherited from QgsLineSymbolLayer
 QgsLineSymbolLayer (const QgsLineSymbolLayer &other)=delete
 QgsLineSymbolLayer cannot be copied. More...
 
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
 Returns the line's offset. More...
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the line's offset. More...
 
QgsUnitTypes::RenderUnit offsetUnit () const
 Returns the units for the line's offset. More...
 
QgsLineSymbolLayeroperator= (const QgsLineSymbolLayer &other)=delete
 QgsLineSymbolLayer cannot be copied. 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, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)
 Renders the line symbol layer along the outline of polygon, using the given render context. More...
 
virtual void renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context)=0
 Renders the line symbol layer along the line joining points, using the given render context. More...
 
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)
 Sets the line's offset. More...
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the line's offset. More...
 
void setOffsetUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit 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)
 Sets the width of the line symbol layer. More...
 
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 QgsMapUnitScalewidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit widthUnit () const
 Returns the units for the line's width. More...
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
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. More...
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
virtual QColor color () const
 Returns the "representative" color of the symbol layer. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
virtual void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size)=0
 
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
 Returns the fill color for the symbol layer. More...
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior. More...
 
virtual bool hasDataDefinedProperties () const
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More...
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol. More...
 
bool isLocked () const
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More...
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QgsMapUnitScale mapUnitScale () const
 
virtual QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual QgsUnitTypes::RenderUnit outputUnit () const
 Returns the units to use for sizes and widths within the symbol layer. More...
 
QgsPaintEffectpaintEffect () 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...
 
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. More...
 
virtual QVariantMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More...
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered. More...
 
virtual void setColor (const QColor &color)
 Sets the "representative" color for the symbol layer. 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)
 Sets the fill color for the symbol layer. More...
 
void setLocked (bool locked)
 Sets whether the layer's colors are locked. More...
 
virtual void setMapUnitScale (const QgsMapUnitScale &scale)
 
virtual void setOutputUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units to use for sizes and widths within the symbol layer. More...
 
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)
 Sets the stroke color for the symbol layer. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
virtual void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called before the layer will be rendered for a particular feature. More...
 
virtual void startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context. More...
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
virtual bool usesMapUnits () const
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
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 QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Create a new QgsArrowSymbolLayer. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 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 (Qgis::SymbolType type, bool locked=false)
 Constructor for QgsSymbolLayer. More...
 
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 QVariantMap &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
QPainterPath mClipPath
 
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< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::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 33 of file qgsarrowsymbollayer.h.

Member Enumeration Documentation

◆ ArrowType

Possible arrow types.

Enumerator
ArrowPlain 
ArrowLeftHalf 
ArrowRightHalf 

Definition at line 133 of file qgsarrowsymbollayer.h.

◆ 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 21 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()

QgsUnitTypes::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()

QgsUnitTypes::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 874 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 114 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 869 of file qgsarrowsymbollayer.cpp.

◆ create()

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

Create a new QgsArrowSymbolLayer.

Parameters
propertiesA property map to deserialize saved information from properties()
Returns
A new QgsArrowSymbolLayer

Definition at line 43 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 177 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()

QgsUnitTypes::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()

QgsUnitTypes::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 128 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 133 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 730 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 ( QgsUnitTypes::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 ( QgsUnitTypes::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 861 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 ( QgsUnitTypes::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 ( QgsUnitTypes::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 ( 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
unitoutput units
See also
outputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 196 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 32 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 205 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 219 of file qgsarrowsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsArrowSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 123 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 168 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 186 of file qgsarrowsymbollayer.cpp.


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