QGIS API Documentation
3.24.2-Tisler (13c1a02865)
|
Line symbol layer type which draws repeating marker symbols along a line feature. More...
#include <qgslinesymbollayer.h>
Public Member Functions | |
QgsMarkerLineSymbolLayer (bool rotateMarker=DEFAULT_MARKERLINE_ROTATE, double interval=DEFAULT_MARKERLINE_INTERVAL) | |
Constructor for QgsMarkerLineSymbolLayer. More... | |
~QgsMarkerLineSymbolLayer () override | |
QgsMarkerLineSymbolLayer * | clone () 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... | |
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... | |
QString | layerType () const override |
Returns a string that represents this layer type. 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... | |
Q_DECL_DEPRECATED bool | rotateMarker () const |
Shall the marker be rotated. More... | |
void | setColor (const QColor &color) override |
Sets the "representative" color for the symbol layer. More... | |
void | setDataDefinedProperty (QgsSymbolLayer::Property key, const QgsProperty &property) override |
Sets a data defined property for the layer. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
Q_DECL_DEPRECATED void | setRotateMarker (bool rotate) |
Shall the marker be rotated. 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 |
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... | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. 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... | |
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... | |
![]() | |
QgsTemplatedLineSymbolLayerBase (bool rotateSymbol=true, double interval=3) | |
Constructor for QgsTemplatedLineSymbolLayerBase. More... | |
~QgsTemplatedLineSymbolLayerBase () override | |
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... | |
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... | |
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... | |
Q_DECL_DEPRECATED Qgis::MarkerLinePlacement | placement () const |
Returns the placement of the symbols. More... | |
Qgis::MarkerLinePlacements | placements () const |
Returns the placement of the symbols. More... | |
bool | placeOnEveryPart () const |
Returns true if the placement applies for every part of multi-part feature geometries. 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 | renderPolygonStroke (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) FINAL |
Renders the line symbol layer along the outline of polygon, 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... | |
Q_DECL_DEPRECATED void | setPlacement (Qgis::MarkerLinePlacement placement) |
Sets the placement of the symbols. More... | |
void | setPlacements (Qgis::MarkerLinePlacements placements) |
Sets the placement of the symbols. More... | |
void | setPlaceOnEveryPart (bool respect) |
Sets whether the placement applies for every part of multi-part feature geometries. More... | |
void | setRotateSymbols (bool rotate) |
Sets whether the repeating symbols should be rotated to match their line segment orientation. More... | |
void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called before the layer will be rendered for a particular feature. More... | |
void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called after the layer has been rendered for a particular feature. More... | |
![]() | |
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 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... | |
QgsLineSymbolLayer & | operator= (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... | |
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... | |
![]() | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
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 |
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 | 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 QList< QgsSymbolLayerReference > | masks () const |
Returns masks defined by this symbol layer. More... | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsSymbolLayer cannot be copied. More... | |
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) |
Sets the fill color for the symbol layer. More... | |
void | setLocked (bool locked) |
Sets whether the layer's colors are locked. 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 QColor | strokeColor () const |
Returns the stroke color for the symbol layer. More... | |
Qgis::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 QVariantMap &properties=QVariantMap()) |
Creates a new QgsMarkerLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsMarkerLineSymbolLayer::properties() ). More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsMarkerLineSymbolLayer from an SLD XML DOM element. More... | |
![]() | |
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... | |
![]() | |
void | copyTemplateSymbolProperties (QgsTemplatedLineSymbolLayerBase *destLayer) const |
Copies all common properties of this layer to another templated symbol layer. More... | |
![]() | |
QgsLineSymbolLayer (bool locked=false) | |
![]() | |
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 | |
std::unique_ptr< QgsMarkerSymbol > | mMarker |
![]() | |
double | mOffset = 0 |
QgsMapUnitScale | mOffsetMapUnitScale |
QgsUnitTypes::RenderUnit | mOffsetUnit = QgsUnitTypes::RenderMillimeters |
RenderRingFilter | mRingFilter = AllRings |
double | mWidth = 0 |
QgsMapUnitScale | mWidthMapUnitScale |
QgsUnitTypes::RenderUnit | mWidthUnit = QgsUnitTypes::RenderMillimeters |
![]() | |
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< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
Qgis::SymbolType | mType |
Line symbol layer type which draws repeating marker symbols along a line feature.
Definition at line 914 of file qgslinesymbollayer.h.
QgsMarkerLineSymbolLayer::QgsMarkerLineSymbolLayer | ( | bool | rotateMarker = DEFAULT_MARKERLINE_ROTATE , |
double | interval = DEFAULT_MARKERLINE_INTERVAL |
||
) |
Constructor for QgsMarkerLineSymbolLayer.
Creates a marker line with a default marker symbol, placed at the specified interval (in millimeters).
The rotateMarker argument specifies whether individual marker symbols should be rotated to match the line segment alignment.
Definition at line 2401 of file qgslinesymbollayer.cpp.
|
overridedefault |
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 2457 of file qgslinesymbollayer.cpp.
|
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).
Reimplemented from QgsSymbolLayer.
Definition at line 2435 of file qgslinesymbollayer.cpp.
|
static |
Creates a new QgsMarkerLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsMarkerLineSymbolLayer::properties() ).
Definition at line 2409 of file qgslinesymbollayer.cpp.
|
static |
Creates a new QgsMarkerLineSymbolLayer from an SLD XML DOM element.
Definition at line 2539 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 2714 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 2705 of file qgslinesymbollayer.cpp.
|
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 2424 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Renders the line symbol layer along the line joining points, using the given render context.
Reimplemented from QgsTemplatedLineSymbolLayerBase.
Definition at line 2635 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 2658 of file qgslinesymbollayer.cpp.
|
inline |
Shall the marker be rotated.
true
if the marker should be rotated. Definition at line 971 of file qgslinesymbollayer.h.
|
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.
Reimplemented from QgsSymbolLayer.
Definition at line 2429 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 2626 of file qgslinesymbollayer.cpp.
|
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 2678 of file qgslinesymbollayer.cpp.
|
inline |
Shall the marker be rotated.
Definition at line 977 of file qgslinesymbollayer.h.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 2382 of file qgslinesymbollayer.cpp.
|
overrideprotectedvirtual |
Sets the symbol's angle, in degrees clockwise.
Implements QgsTemplatedLineSymbolLayerBase.
Definition at line 2653 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 2643 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 2621 of file qgslinesymbollayer.cpp.
|
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.
Implements QgsSymbolLayer.
Definition at line 2440 of file qgslinesymbollayer.cpp.
|
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.
Implements QgsSymbolLayer.
Definition at line 2451 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 2377 of file qgslinesymbollayer.cpp.
|
overrideprotectedvirtual |
Returns the symbol's current angle, in degrees clockwise.
Implements QgsTemplatedLineSymbolLayerBase.
Definition at line 2648 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Definition at line 2464 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 2697 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 2687 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the estimated width for the line symbol layer.
Reimplemented from QgsLineSymbolLayer.
Definition at line 2668 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 2673 of file qgslinesymbollayer.cpp.
|
protected |
Definition at line 983 of file qgslinesymbollayer.h.