QGIS API Documentation
3.0.2-Girona (307d082)
|
Line symbol layer used for representing lines as arrows. More...
#include <qgsarrowsymbollayer.h>
Public Member Functions | |
QgsArrowSymbolLayer () | |
Simple constructor. More... | |
double | arrowStartWidth () const |
Get current arrow start width. Only meaningful for single headed arrows. More... | |
QgsUnitTypes::RenderUnit | arrowStartWidthUnit () const |
Get the unit for the arrow start width. More... | |
QgsMapUnitScale | arrowStartWidthUnitScale () const |
Get the scale for the arrow start width. More... | |
ArrowType | arrowType () const |
Get the current arrow type. More... | |
double | arrowWidth () const |
Get current arrow width. More... | |
QgsUnitTypes::RenderUnit | arrowWidthUnit () const |
Get the unit for the arrow width. More... | |
QgsMapUnitScale | arrowWidthUnitScale () const |
Get 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... | |
double | headLength () const |
Get the current arrow head length. More... | |
QgsUnitTypes::RenderUnit | headLengthUnit () const |
Get the unit for the head length. More... | |
QgsMapUnitScale | headLengthUnitScale () const |
Get the scale for the head length. More... | |
double | headThickness () const |
Get the current arrow head height. More... | |
QgsUnitTypes::RenderUnit | headThicknessUnit () const |
Get the unit for the head height. More... | |
QgsMapUnitScale | headThicknessUnitScale () const |
Get the scale for the head height. More... | |
HeadType | headType () const |
Get the current head type. More... | |
bool | isCurved () const |
Return whether it is a curved arrow or a straight one. More... | |
bool | isRepeated () const |
Return 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) |
Set the arrow start width. More... | |
void | setArrowStartWidthUnit (QgsUnitTypes::RenderUnit unit) |
Set the unit for the arrow start width. More... | |
void | setArrowStartWidthUnitScale (const QgsMapUnitScale &scale) |
Set the scale for the arrow start width. More... | |
void | setArrowType (ArrowType type) |
Set the arrow type. More... | |
void | setArrowWidth (double width) |
Set the arrow width. More... | |
void | setArrowWidthUnit (QgsUnitTypes::RenderUnit unit) |
Set the unit for the arrow width. More... | |
void | setArrowWidthUnitScale (const QgsMapUnitScale &scale) |
Set the scale for the arrow width. More... | |
void | setColor (const QColor &c) override |
The fill color. More... | |
void | setHeadLength (double length) |
Set the arrow head length. More... | |
void | setHeadLengthUnit (QgsUnitTypes::RenderUnit unit) |
Set the unit for the head length. More... | |
void | setHeadLengthUnitScale (const QgsMapUnitScale &scale) |
Set the scale for the head length. More... | |
void | setHeadThickness (double thickness) |
Set the arrow head height. More... | |
void | setHeadThicknessUnit (QgsUnitTypes::RenderUnit unit) |
Set the unit for the head height. More... | |
void | setHeadThicknessUnitScale (const QgsMapUnitScale &scale) |
Set the scale for the head height. More... | |
void | setHeadType (HeadType type) |
Set the head type. More... | |
void | setIsCurved (bool isCurved) |
Set whether it is a curved arrow or a straight one. More... | |
void | setIsRepeated (bool isRepeated) |
Set whether the arrow is repeated along the line. More... | |
bool | setSubSymbol (QgsSymbol *symbol) override |
set 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 |
get 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) |
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... | |
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 |
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 |
get angle More... | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
get brush/fill color More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
get brush/fill style More... | |
virtual QColor | dxfColor (QgsSymbolRenderContext &context) const |
get color More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
get dash pattern More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
get offset More... | |
virtual Qt::PenStyle | dxfPenStyle () const |
get 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 |
Get 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 |
Get 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 |
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... | |
Line symbol layer used for representing lines as arrows.
Definition at line 31 of file qgsarrowsymbollayer.h.
Possible arrow types.
Enumerator | |
---|---|
ArrowPlain | |
ArrowLeftHalf | |
ArrowRightHalf |
Definition at line 127 of file qgsarrowsymbollayer.h.
Possible head types.
Enumerator | |
---|---|
HeadSingle | |
HeadReversed | |
HeadDouble |
Definition at line 114 of file qgsarrowsymbollayer.h.
QgsArrowSymbolLayer::QgsArrowSymbolLayer | ( | ) |
Simple constructor.
Definition at line 18 of file qgsarrowsymbollayer.cpp.
|
inline |
Get current arrow start width. Only meaningful for single headed arrows.
Definition at line 65 of file qgsarrowsymbollayer.h.
|
inline |
Get the unit for the arrow start width.
Definition at line 69 of file qgsarrowsymbollayer.h.
|
inline |
Get the scale for the arrow start width.
Definition at line 73 of file qgsarrowsymbollayer.h.
|
inline |
Get the current arrow type.
Definition at line 135 of file qgsarrowsymbollayer.h.
|
inline |
Get current arrow width.
Definition at line 52 of file qgsarrowsymbollayer.h.
|
inline |
Get the unit for the arrow width.
Definition at line 56 of file qgsarrowsymbollayer.h.
|
inline |
Get the scale for the arrow width.
Definition at line 60 of file qgsarrowsymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 106 of file qgsarrowsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 791 of file qgsarrowsymbollayer.cpp.
|
static |
Create a new QgsArrowSymbolLayer.
properties | A property map to deserialize saved information from properties() |
Definition at line 38 of file qgsarrowsymbollayer.cpp.
|
inline |
Get the current arrow head length.
Definition at line 78 of file qgsarrowsymbollayer.h.
|
inline |
Get the unit for the head length.
Definition at line 82 of file qgsarrowsymbollayer.h.
|
inline |
Get the scale for the head length.
Definition at line 86 of file qgsarrowsymbollayer.h.
|
inline |
Get the current arrow head height.
Definition at line 91 of file qgsarrowsymbollayer.h.
|
inline |
Get the unit for the head height.
Definition at line 95 of file qgsarrowsymbollayer.h.
|
inline |
Get the scale for the head height.
Definition at line 99 of file qgsarrowsymbollayer.h.
|
inline |
Get the current head type.
Definition at line 122 of file qgsarrowsymbollayer.h.
|
inline |
Return whether it is a curved arrow or a straight one.
Definition at line 104 of file qgsarrowsymbollayer.h.
|
inline |
Return whether the arrow is repeated along the line or not.
Definition at line 109 of file qgsarrowsymbollayer.h.
|
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 115 of file qgsarrowsymbollayer.cpp.
|
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 120 of file qgsarrowsymbollayer.cpp.
|
overridevirtual |
Implements QgsLineSymbolLayer.
Definition at line 670 of file qgsarrowsymbollayer.cpp.
|
inline |
Set the arrow start width.
Definition at line 67 of file qgsarrowsymbollayer.h.
|
inline |
Set the unit for the arrow start width.
Definition at line 71 of file qgsarrowsymbollayer.h.
|
inline |
Set the scale for the arrow start width.
Definition at line 75 of file qgsarrowsymbollayer.h.
|
inline |
Set the arrow type.
Definition at line 137 of file qgsarrowsymbollayer.h.
|
inline |
Set the arrow width.
Definition at line 54 of file qgsarrowsymbollayer.h.
|
inline |
Set the unit for the arrow width.
Definition at line 58 of file qgsarrowsymbollayer.h.
|
inline |
Set the scale for the arrow width.
Definition at line 62 of file qgsarrowsymbollayer.h.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 783 of file qgsarrowsymbollayer.cpp.
|
inline |
Set the arrow head length.
Definition at line 80 of file qgsarrowsymbollayer.h.
|
inline |
Set the unit for the head length.
Definition at line 84 of file qgsarrowsymbollayer.h.
|
inline |
Set the scale for the head length.
Definition at line 88 of file qgsarrowsymbollayer.h.
|
inline |
Set the arrow head height.
Definition at line 93 of file qgsarrowsymbollayer.h.
|
inline |
Set the unit for the head height.
Definition at line 97 of file qgsarrowsymbollayer.h.
|
inline |
Set the scale for the head height.
Definition at line 101 of file qgsarrowsymbollayer.h.
|
inline |
Set the head type.
Definition at line 124 of file qgsarrowsymbollayer.h.
|
inline |
Set whether it is a curved arrow or a straight one.
Definition at line 106 of file qgsarrowsymbollayer.h.
|
inline |
Set whether the arrow is repeated along the line.
Definition at line 111 of file qgsarrowsymbollayer.h.
|
overridevirtual |
set layer's subsymbol. takes ownership of the passed symbol
Reimplemented from QgsSymbolLayer.
Definition at line 27 of file qgsarrowsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 163 of file qgsarrowsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 177 of file qgsarrowsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 47 of file qgsarrowsymbollayer.h.
|
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 153 of file qgsarrowsymbollayer.cpp.