QGIS API Documentation
3.8.0-Zanzibar (11aff65)
|
Line symbol layer type which draws repeating line sections along a line feature. More...
#include <qgslinesymbollayer.h>
Public Member Functions | |
QgsHashedLineSymbolLayer (bool rotateSymbol=true, double interval=3) | |
Constructor for QgsHashedLineSymbolLayer. More... | |
QgsHashedLineSymbolLayer * | 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 | estimateMaxBleed (const QgsRenderContext &context) const override |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. More... | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
double | hashAngle () const |
Returns the angle to use when drawing the hashed lines sections, in degrees clockwise. More... | |
double | hashLength () const |
Returns the length of hash symbols. More... | |
const QgsMapUnitScale & | hashLengthMapUnitScale () const |
Returns the map unit scale for the hash length. More... | |
QgsUnitTypes::RenderUnit | hashLengthUnit () const |
Returns the units for the length of hash symbols. 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 | setColor (const QColor &color) override |
The fill color. More... | |
void | setDataDefinedProperty (QgsSymbolLayer::Property key, const QgsProperty &property) override |
Sets a data defined property for the layer. More... | |
void | setHashAngle (double angle) |
Sets the angle to use when drawing the hashed lines sections, in degrees clockwise. More... | |
void | setHashLength (double length) |
Sets the length of hash symbols. More... | |
void | setHashLengthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the hash length. More... | |
void | setHashLengthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the length of hash symbols. 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 | setWidth (double width) override |
Sets the width of the line symbol layer. 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... | |
double | width () const override |
Returns the estimated width for the line symbol layer. More... | |
double | width (const QgsRenderContext &context) const override |
Returns the line symbol layer width, in painter units. More... | |
Public Member Functions inherited from QgsTemplatedLineSymbolLayerBase | |
QgsTemplatedLineSymbolLayerBase (bool rotateSymbol=true, double interval=3) | |
Constructor for QgsTemplatedLineSymbolLayerBase. More... | |
double | averageAngleLength () const |
Returns the length of line over which the line's direction is averaged when calculating individual symbol angles. More... | |
const QgsMapUnitScale & | averageAngleMapUnitScale () const |
Returns the map unit scale for the length over which the line's direction is averaged when calculating individual symbol angles. More... | |
QgsUnitTypes::RenderUnit | averageAngleUnit () const |
Returns the unit for the length over which the line's direction is averaged when calculating individual symbol angles. More... | |
double | interval () const |
Returns the interval between individual symbols. More... | |
const QgsMapUnitScale & | intervalMapUnitScale () const |
Returns the map unit scale for the interval between symbols. More... | |
QgsUnitTypes::RenderUnit | intervalUnit () const |
Returns the units for the interval between symbols. More... | |
QgsMapUnitScale | mapUnitScale () const FINAL |
double | offsetAlongLine () const |
Returns the offset along the line for the symbol placement. More... | |
const QgsMapUnitScale & | offsetAlongLineMapUnitScale () const |
Returns the map unit scale used for calculating the offset in map units along line for symbols. More... | |
QgsUnitTypes::RenderUnit | offsetAlongLineUnit () const |
Returns the unit used for calculating the offset along line for symbols. More... | |
QgsUnitTypes::RenderUnit | outputUnit () const FINAL |
Returns the units to use for sizes and widths within the symbol layer. More... | |
Placement | placement () const |
Returns the placement of the symbols. More... | |
void | renderPolygonStroke (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) FINAL |
Renders the line symbol layer along the outline of polygon, using the given render context. More... | |
void | renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context) FINAL |
Renders the line symbol layer along the line joining points, using the given render context. More... | |
bool | rotateSymbols () const |
Returns true if the repeating symbols be rotated to match their line segment orientation. More... | |
void | setAverageAngleLength (double length) |
Sets the length of line over which the line's direction is averaged when calculating individual symbol angles. More... | |
void | setAverageAngleMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the length over which the line's direction is averaged when calculating individual symbol angles. More... | |
void | setAverageAngleUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit for the length over which the line's direction is averaged when calculating individual symbol angles. More... | |
void | setInterval (double interval) |
Sets the interval between individual symbols. More... | |
void | setIntervalMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the interval between symbols. More... | |
void | setIntervalUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the interval between symbols. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) FINAL |
void | setOffsetAlongLine (double offsetAlongLine) |
Sets the the offset along the line for the symbol placement. More... | |
void | setOffsetAlongLineMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale used for calculating the offset in map units along line for symbols. More... | |
void | setOffsetAlongLineUnit (QgsUnitTypes::RenderUnit unit) |
Sets the unit used for calculating the offset along line for symbols. More... | |
void | setPlacement (Placement placement) |
Sets the placement of the symbols. More... | |
void | setRotateSymbols (bool rotate) |
Sets whether the repeating symbols should be rotated to match their line segment orientation. 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 |
Returns the line's offset. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () 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... | |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. 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... | |
void | setWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the line's width. 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 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 |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. More... | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. More... | |
void | setLocked (bool locked) |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual void | setStrokeColor (const QColor &color) |
Set stroke color. More... | |
virtual QColor | strokeColor () const |
Gets stroke color. More... | |
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()) |
Creates a new QgsHashedLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsHashedLineSymbolLayer::properties() ). More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
void | renderSymbol (const QPointF &point, const QgsFeature *feature, QgsRenderContext &context, int layer=-1, bool selected=false) override |
Renders the templated symbol at the specified point, using the given render context. More... | |
void | setSymbolAngle (double angle) override |
Sets the symbol's angle, in degrees clockwise. More... | |
void | setSymbolLineAngle (double angle) override |
Sets the line angle modification for the symbol's angle. More... | |
double | symbolAngle () const override |
Returns the symbol's current angle, in degrees clockwise. More... | |
Protected Member Functions inherited from QgsTemplatedLineSymbolLayerBase | |
void | copyTemplateSymbolProperties (QgsTemplatedLineSymbolLayerBase *destLayer) const |
Copies all common properties of this layer to another templated symbol layer. More... | |
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... | |
Line symbol layer type which draws repeating line sections along a line feature.
Definition at line 655 of file qgslinesymbollayer.h.
QgsHashedLineSymbolLayer::QgsHashedLineSymbolLayer | ( | bool | rotateSymbol = true , |
double | interval = 3 |
||
) |
Constructor for QgsHashedLineSymbolLayer.
Creates a line with a default hash symbol, placed at the specified interval (in millimeters).
The rotateSymbol argument specifies whether individual hash symbols should be rotated to match the line segment alignment.
Definition at line 2012 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2082 of file qgslinesymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 2099 of file qgslinesymbollayer.cpp.
|
static |
Creates a new QgsHashedLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsHashedLineSymbolLayer::properties() ).
Definition at line 2018 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.
For example, polygons drawn with an stroke will draw half the width of the stroke outside of the polygon. This amount is estimated, since it may be affected by data defined symbology rules.
Reimplemented from QgsSymbolLayer.
Definition at line 2137 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsSymbolLayer.
Definition at line 2161 of file qgslinesymbollayer.cpp.
double QgsHashedLineSymbolLayer::hashAngle | ( | ) | const |
Returns the angle to use when drawing the hashed lines sections, in degrees clockwise.
Definition at line 2221 of file qgslinesymbollayer.cpp.
|
inline |
Returns the length of hash symbols.
Units are specified through hashLengthUnits().
Definition at line 713 of file qgslinesymbollayer.h.
|
inline |
Returns the map unit scale for the hash length.
Definition at line 750 of file qgslinesymbollayer.h.
|
inline |
Returns the units for the length of hash symbols.
Definition at line 734 of file qgslinesymbollayer.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 2047 of file qgslinesymbollayer.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.
Reimplemented from QgsTemplatedLineSymbolLayerBase.
Definition at line 2070 of file qgslinesymbollayer.cpp.
|
overrideprotectedvirtual |
Renders the templated symbol at the specified point, using the given render context.
The feature argument is used to pass the feature currently being rendered (when available).
If only a single symbol layer from the symbol should be rendered, it should be specified in the layer argument. A layer of -1 indicates that all symbol layers should be rendered.
If selected is true then the symbol will be drawn using the "selected feature" style and colors instead of the symbol's normal style.
Implements QgsTemplatedLineSymbolLayerBase.
Definition at line 2194 of file qgslinesymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 2093 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Sets a data defined property for the layer.
Any existing property with the same key will be overwritten.
Reimplemented from QgsSymbolLayer.
Definition at line 2170 of file qgslinesymbollayer.cpp.
void QgsHashedLineSymbolLayer::setHashAngle | ( | double | angle | ) |
Sets the angle to use when drawing the hashed lines sections, in degrees clockwise.
Definition at line 2226 of file qgslinesymbollayer.cpp.
|
inline |
Sets the length of hash symbols.
Units are specified through setHashLengthUnit()
Definition at line 720 of file qgslinesymbollayer.h.
|
inline |
Sets the map unit scale for the hash length.
Definition at line 742 of file qgslinesymbollayer.h.
|
inline |
Sets the unit for the length of hash symbols.
Definition at line 727 of file qgslinesymbollayer.h.
|
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.
unit | output units |
Reimplemented from QgsSymbolLayer.
Definition at line 2144 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 2109 of file qgslinesymbollayer.cpp.
|
overrideprotectedvirtual |
Sets the symbol's angle, in degrees clockwise.
Implements QgsTemplatedLineSymbolLayerBase.
Definition at line 2189 of file qgslinesymbollayer.cpp.
|
overrideprotectedvirtual |
Sets the line angle modification for the symbol's angle.
This angle is added to the symbol's rotation and data defined rotation before rendering the symbol, and is used for orienting symbols to match the line's angle.
angle | Angle in degrees, valid values are between 0 and 360 |
Implements QgsTemplatedLineSymbolLayerBase.
Definition at line 2179 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Sets the width of the line symbol layer.
Calling this method updates the width of the line symbol layer, without changing the existing width units. It has different effects depending on the line symbol layer subclass, e.g. for a simple line layer it changes the stroke width of the line, for a marker line layer it changes the size of the markers used to draw the line.
Reimplemented from QgsLineSymbolLayer.
Definition at line 2122 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 2052 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 2065 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 2104 of file qgslinesymbollayer.cpp.
|
overrideprotectedvirtual |
Returns the symbol's current angle, in degrees clockwise.
Implements QgsTemplatedLineSymbolLayerBase.
Definition at line 2184 of file qgslinesymbollayer.cpp.
|
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 2153 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the estimated width for the line symbol layer.
Reimplemented from QgsLineSymbolLayer.
Definition at line 2127 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the line symbol layer width, in painter units.
This method returns an accurate width by calculating the actual rendered width of the symbol layer using the provided render context.
Reimplemented from QgsLineSymbolLayer.
Definition at line 2132 of file qgslinesymbollayer.cpp.