QGIS API Documentation 3.36.0-Maidenhead (09951dc0acf)
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsMarkerLineSymbolLayer Class Reference

Line symbol layer type which draws repeating marker symbols along a line feature. More...

#include <qgslinesymbollayer.h>

Inheritance diagram for QgsMarkerLineSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsMarkerLineSymbolLayer (bool rotateMarker=DEFAULT_MARKERLINE_ROTATE, double interval=DEFAULT_MARKERLINE_INTERVAL)
 Constructor for QgsMarkerLineSymbolLayer.
 
 ~QgsMarkerLineSymbolLayer () override
 
QgsMarkerLineSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance.
 
QColor color () const override
 Returns the "representative" color of the symbol layer.
 
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.
 
bool hasDataDefinedProperties () const override
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties.
 
QString layerType () const override
 Returns a string that represents this layer type.
 
void renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context) override
 Renders the line symbol layer along the line joining points, using the given render context.
 
Q_DECL_DEPRECATED bool rotateMarker () const
 Shall the marker be rotated.
 
void setColor (const QColor &color) override
 Sets the "representative" color for the symbol layer.
 
void setDataDefinedProperty (QgsSymbolLayer::Property key, const QgsProperty &property) override
 Sets a data defined property for the layer.
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer.
 
Q_DECL_DEPRECATED void setRotateMarker (bool rotate)
 Shall the marker be rotated.
 
bool setSubSymbol (QgsSymbol *symbol) override
 Sets layer's subsymbol. takes ownership of the passed symbol.
 
void setWidth (double width) override
 Sets the width of the line symbol layer.
 
void startRender (QgsSymbolRenderContext &context) override
 Called before a set of rendering operations commences on the supplied render context.
 
void stopRender (QgsSymbolRenderContext &context) override
 Called after a set of rendering operations has finished on the supplied render context.
 
QgsSymbolsubSymbol () override
 Returns the symbol's sub symbol, if present.
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD.
 
QSet< QString > usedAttributes (const QgsRenderContext &context) const override
 Returns the set of attributes referenced by the layer.
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes.
 
double width () const override
 Returns the estimated width for the line symbol layer.
 
double width (const QgsRenderContext &context) const override
 Returns the line symbol layer width, in painter units.
 
- Public Member Functions inherited from QgsTemplatedLineSymbolLayerBase
 QgsTemplatedLineSymbolLayerBase (bool rotateSymbol=true, double interval=3)
 Constructor for QgsTemplatedLineSymbolLayerBase.
 
 ~QgsTemplatedLineSymbolLayerBase () override
 
double averageAngleLength () const
 Returns the length of line over which the line's direction is averaged when calculating individual symbol angles.
 
const QgsMapUnitScaleaverageAngleMapUnitScale () const
 Returns the map unit scale for the length over which the line's direction is averaged when calculating individual symbol angles.
 
Qgis::RenderUnit averageAngleUnit () const
 Returns the unit for the length over which the line's direction is averaged when calculating individual symbol angles.
 
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.
 
double interval () const
 Returns the interval between individual symbols.
 
const QgsMapUnitScaleintervalMapUnitScale () const
 Returns the map unit scale for the interval between symbols.
 
Qgis::RenderUnit intervalUnit () const
 Returns the units for the interval between symbols.
 
QgsMapUnitScale mapUnitScale () const FINAL
 
double offsetAlongLine () const
 Returns the offset along the line for the symbol placement.
 
const QgsMapUnitScaleoffsetAlongLineMapUnitScale () const
 Returns the map unit scale used for calculating the offset in map units along line for symbols.
 
Qgis::RenderUnit offsetAlongLineUnit () const
 Returns the unit used for calculating the offset along line for symbols.
 
Qgis::RenderUnit outputUnit () const FINAL
 Returns the units to use for sizes and widths within the symbol layer.
 
Q_DECL_DEPRECATED Qgis::MarkerLinePlacement placement () const
 Returns the placement of the symbols.
 
Qgis::MarkerLinePlacements placements () const
 Returns the placement of the symbols.
 
bool placeOnEveryPart () const
 Returns true if the placement applies for every part of multi-part feature geometries.
 
QVariantMap properties () const override
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.
 
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.
 
void renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context) override
 Renders the line symbol layer along the line joining points, using the given render context.
 
bool rotateSymbols () const
 Returns true if the repeating symbols be rotated to match their line segment orientation.
 
void setAverageAngleLength (double length)
 Sets the length of line over which the line's direction is averaged when calculating individual symbol angles.
 
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.
 
void setAverageAngleUnit (Qgis::RenderUnit unit)
 Sets the unit for the length over which the line's direction is averaged when calculating individual symbol angles.
 
void setInterval (double interval)
 Sets the interval between individual symbols.
 
void setIntervalMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the interval between symbols.
 
void setIntervalUnit (Qgis::RenderUnit unit)
 Sets the units for the interval between symbols.
 
void setMapUnitScale (const QgsMapUnitScale &scale) FINAL
 
void setOffsetAlongLine (double offsetAlongLine)
 Sets the the offset along the line for the symbol placement.
 
void setOffsetAlongLineMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale used for calculating the offset in map units along line for symbols.
 
void setOffsetAlongLineUnit (Qgis::RenderUnit unit)
 Sets the unit used for calculating the offset along line for symbols.
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer.
 
Q_DECL_DEPRECATED void setPlacement (Qgis::MarkerLinePlacement placement)
 Sets the placement of the symbols.
 
void setPlacements (Qgis::MarkerLinePlacements placements)
 Sets the placement of the symbols.
 
void setPlaceOnEveryPart (bool respect)
 Sets whether the placement applies for every part of multi-part feature geometries.
 
void setRotateSymbols (bool rotate)
 Sets whether the repeating symbols should be rotated to match their line segment orientation.
 
void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override
 Called before the layer will be rendered for a particular feature.
 
void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override
 Called after the layer has been rendered for a particular feature.
 
- Public Member Functions inherited from QgsLineSymbolLayer
 QgsLineSymbolLayer (const QgsLineSymbolLayer &other)=delete
 QgsLineSymbolLayer cannot be copied.
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width.
 
double offset () const
 Returns the line's offset.
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the line's offset.
 
Qgis::RenderUnit offsetUnit () const
 Returns the units for the line's offset.
 
QgsLineSymbolLayeroperator= (const QgsLineSymbolLayer &other)=delete
 QgsLineSymbolLayer cannot be copied.
 
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.
 
void setOffset (double offset)
 Sets the line's offset.
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the line's offset.
 
void setOffsetUnit (Qgis::RenderUnit unit)
 Sets the unit for the line's offset.
 
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.
 
void setWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setWidthUnit (Qgis::RenderUnit unit)
 Sets the units for the line's width.
 
const QgsMapUnitScalewidthMapUnitScale () const
 
Qgis::RenderUnit widthUnit () const
 Returns the units for the line's width.
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied.
 
virtual ~QgsSymbolLayer ()
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 Gets angle.
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 Gets brush/fill color.
 
virtual Qt::BrushStyle dxfBrushStyle () const
 Gets brush/fill style.
 
virtual QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color.
 
virtual QVector< qreal > dxfCustomDashPattern (Qgis::RenderUnit &unit) const
 Gets dash pattern.
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset.
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style.
 
virtual double dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets marker size.
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn.
 
virtual QColor fillColor () const
 Returns the fill color for the symbol layer.
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior.
 
QString id () const
 Returns symbol layer identifier This id is unique in the whole project.
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol.
 
bool isLocked () const
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.
 
virtual QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer.
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied.
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer.
 
virtual void prepareExpressions (const QgsSymbolRenderContext &context)
 Prepares all data defined property expressions for evaluation.
 
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.
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered.
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the symbol layer's property collection, used for data defined overrides.
 
void setEnabled (bool enabled)
 Sets whether symbol layer is enabled and should be drawn.
 
virtual void setFillColor (const QColor &color)
 Sets the fill color for the symbol layer.
 
void setId (const QString &id)
 Set symbol layer identifier This id has to be unique in the whole project.
 
void setLocked (bool locked)
 Sets whether the layer's colors are locked.
 
void setPaintEffect (QgsPaintEffect *effect)
 Sets the current paint effect for the layer.
 
void setRenderingPass (int renderingPass)
 Specifies the rendering pass in which this symbol layer should be rendered.
 
virtual void setStrokeColor (const QColor &color)
 Sets the stroke color for the symbol layer.
 
void setUserFlags (Qgis::SymbolLayerUserFlags flags)
 Sets user-controlled flags which control the symbol layer's behavior.
 
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer.
 
Qgis::SymbolType type () const
 
Qgis::SymbolLayerUserFlags userFlags () const
 Returns user-controlled flags which control the symbol layer's behavior.
 
virtual bool writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
 write as DXF
 

Static Public Member Functions

static QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsMarkerLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsMarkerLineSymbolLayer::properties() ).
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 Creates a new QgsMarkerLineSymbolLayer from an SLD XML DOM element.
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions.
 

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.
 
void setSymbolAngle (double angle) override
 Sets the symbol's angle, in degrees clockwise.
 
void setSymbolLineAngle (double angle) override
 Sets the line angle modification for the symbol's angle.
 
double symbolAngle () const override
 Returns the symbol's current angle, in degrees clockwise.
 
- Protected Member Functions inherited from QgsTemplatedLineSymbolLayerBase
void copyTemplateSymbolProperties (QgsTemplatedLineSymbolLayerBase *destLayer) const
 Copies all common properties of this layer to another templated symbol layer.
 
- 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.
 
void copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
 Copies all data defined properties of this layer to another symbol layer.
 
void copyPaintEffect (QgsSymbolLayer *destLayer) const
 Copies paint effect of this layer to another symbol layer.
 
void installMasks (QgsRenderContext &context, bool recursive)
 When rendering, install masks on context painter if recursive is true masks are installed recursively for all children symbol layers.
 
void removeMasks (QgsRenderContext &context, bool recursive)
 When rendering, remove previously installed masks from context painter if recursive is true masks are removed recursively for all children symbol layers.
 
void restoreOldDataDefinedProperties (const QVariantMap &stringMap)
 Restores older data defined properties from string map.
 
bool shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
 Returns true if the symbol layer should be rendered using the selection color from the render context.
 

Protected Attributes

std::unique_ptr< QgsMarkerSymbolmMarker
 
- Protected Attributes inherited from QgsLineSymbolLayer
double mOffset = 0
 
QgsMapUnitScale mOffsetMapUnitScale
 
Qgis::RenderUnit mOffsetUnit = Qgis::RenderUnit::Millimeters
 
RenderRingFilter mRingFilter = AllRings
 
double mWidth = 0
 
QgsMapUnitScale mWidthMapUnitScale
 
Qgis::RenderUnit mWidthUnit = Qgis::RenderUnit::Millimeters
 
- Protected Attributes inherited from QgsSymbolLayer
QPainterPath mClipPath
 
QColor mColor
 
QgsPropertyCollection mDataDefinedProperties
 
bool mEnabled = true
 True if layer is enabled and should be drawn.
 
QgsFields mFields
 
QString mId
 
bool mLocked = false
 
std::unique_ptr< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 
Qgis::SymbolLayerUserFlags mUserFlags
 User controlled flags.
 

Additional Inherited Members

- 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 class  Property : int {
  Size = 0 , Angle , Name , FillColor ,
  StrokeColor , StrokeWidth , StrokeStyle , Offset ,
  Character , Width , Height , PreserveAspectRatio ,
  FillStyle , JoinStyle , SecondaryColor , LineAngle ,
  LineDistance , GradientType , CoordinateMode , GradientSpread ,
  GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y ,
  GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape ,
  ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX ,
  DistanceY , DisplacementX , DisplacementY , Opacity ,
  CustomDash , CapStyle , Placement , Interval ,
  OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor ,
  LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength ,
  ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX ,
  OffsetY , PointCount , RandomSeed , ClipPoints ,
  DensityArea , FontFamily , FontStyle , DashPatternOffset ,
  TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue ,
  LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX ,
  RandomOffsetY , LineClipping
}
 Data definable properties. More...
 
- Static Protected Member Functions inherited from QgsTemplatedLineSymbolLayerBase
static void setCommonProperties (QgsTemplatedLineSymbolLayerBase *destLayer, const QVariantMap &properties)
 Sets all common symbol properties in the destLayer, using the settings serialized in the properties map.
 
- Static Protected Attributes inherited from QgsSymbolLayer
static const bool SELECT_FILL_BORDER = false
 Whether fill styles for selected features also highlight symbol stroke.
 
static const bool SELECT_FILL_STYLE = false
 Whether fill styles for selected features uses symbol layer style.
 
static const bool SELECTION_IS_OPAQUE = true
 Whether styles for selected features ignore symbol alpha.
 

Detailed Description

Line symbol layer type which draws repeating marker symbols along a line feature.

Definition at line 916 of file qgslinesymbollayer.h.

Constructor & Destructor Documentation

◆ QgsMarkerLineSymbolLayer()

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 2425 of file qgslinesymbollayer.cpp.

◆ ~QgsMarkerLineSymbolLayer()

QgsMarkerLineSymbolLayer::~QgsMarkerLineSymbolLayer ( )
overridedefault

Member Function Documentation

◆ clone()

QgsMarkerLineSymbolLayer * QgsMarkerLineSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 2481 of file qgslinesymbollayer.cpp.

◆ color()

QColor QgsMarkerLineSymbolLayer::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 2459 of file qgslinesymbollayer.cpp.

◆ create()

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

Creates a new QgsMarkerLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsMarkerLineSymbolLayer::properties() ).

Definition at line 2433 of file qgslinesymbollayer.cpp.

◆ createFromSld()

QgsSymbolLayer * QgsMarkerLineSymbolLayer::createFromSld ( QDomElement &  element)
static

Creates a new QgsMarkerLineSymbolLayer from an SLD XML DOM element.

Definition at line 2563 of file qgslinesymbollayer.cpp.

◆ estimateMaxBleed()

double QgsMarkerLineSymbolLayer::estimateMaxBleed ( const QgsRenderContext context) const
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 2737 of file qgslinesymbollayer.cpp.

◆ hasDataDefinedProperties()

bool QgsMarkerLineSymbolLayer::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 2728 of file qgslinesymbollayer.cpp.

◆ layerType()

QString QgsMarkerLineSymbolLayer::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 2448 of file qgslinesymbollayer.cpp.

◆ renderPolyline()

void QgsMarkerLineSymbolLayer::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 2661 of file qgslinesymbollayer.cpp.

◆ renderSymbol()

void QgsMarkerLineSymbolLayer::renderSymbol ( const QPointF &  point,
const QgsFeature feature,
QgsRenderContext context,
int  layer = -1,
bool  selected = false 
)
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 2684 of file qgslinesymbollayer.cpp.

◆ rotateMarker()

Q_DECL_DEPRECATED bool QgsMarkerLineSymbolLayer::rotateMarker ( ) const
inline

Shall the marker be rotated.

Returns
true if the marker should be rotated.
Deprecated:
Use rotateSymbols() instead.

Definition at line 973 of file qgslinesymbollayer.h.

◆ setColor()

void QgsMarkerLineSymbolLayer::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 2453 of file qgslinesymbollayer.cpp.

◆ setDataDefinedProperty()

void QgsMarkerLineSymbolLayer::setDataDefinedProperty ( QgsSymbolLayer::Property  key,
const QgsProperty property 
)
overridevirtual

Sets a data defined property for the layer.

Any existing property with the same key will be overwritten.

See also
dataDefinedProperties()
Property

Reimplemented from QgsSymbolLayer.

Definition at line 2652 of file qgslinesymbollayer.cpp.

◆ setOutputUnit()

void QgsMarkerLineSymbolLayer::setOutputUnit ( Qgis::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 QgsLineSymbolLayer.

Definition at line 2704 of file qgslinesymbollayer.cpp.

◆ setRotateMarker()

Q_DECL_DEPRECATED void QgsMarkerLineSymbolLayer::setRotateMarker ( bool  rotate)
inline

Shall the marker be rotated.

Deprecated:
Use setRotateSymbols() instead.

Definition at line 979 of file qgslinesymbollayer.h.

◆ setSubSymbol()

bool QgsMarkerLineSymbolLayer::setSubSymbol ( QgsSymbol symbol)
overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 2406 of file qgslinesymbollayer.cpp.

◆ setSymbolAngle()

void QgsMarkerLineSymbolLayer::setSymbolAngle ( double  angle)
overrideprotectedvirtual

Sets the symbol's angle, in degrees clockwise.

Implements QgsTemplatedLineSymbolLayerBase.

Definition at line 2679 of file qgslinesymbollayer.cpp.

◆ setSymbolLineAngle()

void QgsMarkerLineSymbolLayer::setSymbolLineAngle ( double  angle)
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.

Parameters
angleAngle in degrees, valid values are between 0 and 360

Implements QgsTemplatedLineSymbolLayerBase.

Definition at line 2669 of file qgslinesymbollayer.cpp.

◆ setWidth()

void QgsMarkerLineSymbolLayer::setWidth ( double  width)
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.

See also
width()
Warning
Since the width units vary, this method is useful for changing the relative width of a line symbol layer only.

Reimplemented from QgsLineSymbolLayer.

Definition at line 2647 of file qgslinesymbollayer.cpp.

◆ startRender()

void QgsMarkerLineSymbolLayer::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 2464 of file qgslinesymbollayer.cpp.

◆ stopRender()

void QgsMarkerLineSymbolLayer::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 2475 of file qgslinesymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsMarkerLineSymbolLayer::subSymbol ( )
overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 2401 of file qgslinesymbollayer.cpp.

◆ symbolAngle()

double QgsMarkerLineSymbolLayer::symbolAngle ( ) const
overrideprotectedvirtual

Returns the symbol's current angle, in degrees clockwise.

Implements QgsTemplatedLineSymbolLayerBase.

Definition at line 2674 of file qgslinesymbollayer.cpp.

◆ toSld()

void QgsMarkerLineSymbolLayer::toSld ( QDomDocument &  doc,
QDomElement &  element,
const QVariantMap &  props 
) const
overridevirtual

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 2488 of file qgslinesymbollayer.cpp.

◆ usedAttributes()

QSet< QString > QgsMarkerLineSymbolLayer::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 2720 of file qgslinesymbollayer.cpp.

◆ usesMapUnits()

bool QgsMarkerLineSymbolLayer::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 2710 of file qgslinesymbollayer.cpp.

◆ width() [1/2]

double QgsMarkerLineSymbolLayer::width ( ) const
overridevirtual

Returns the estimated width for the line symbol layer.

Warning
This returned value is inaccurate if the symbol layer has sub-symbols with different width units. Use the overload accepting a QgsRenderContext argument instead for accurate sizes in this case.
See also
setWidth()

Reimplemented from QgsLineSymbolLayer.

Definition at line 2694 of file qgslinesymbollayer.cpp.

◆ width() [2/2]

double QgsMarkerLineSymbolLayer::width ( const QgsRenderContext context) const
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.

See also
setWidth()
Since
QGIS 3.4.5

Reimplemented from QgsLineSymbolLayer.

Definition at line 2699 of file qgslinesymbollayer.cpp.

Member Data Documentation

◆ mMarker

std::unique_ptr< QgsMarkerSymbol > QgsMarkerLineSymbolLayer::mMarker
protected

Definition at line 985 of file qgslinesymbollayer.h.


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