Line symbol layer used for decorating accordingly to linear referencing. More...

#include <qgslinearreferencingsymbollayer.h>

Inheritance diagram for QgsLinearReferencingSymbolLayer:

[legend]

Public Member Functions
	QgsLinearReferencingSymbolLayer ()

	~QgsLinearReferencingSymbolLayer () override

double	averageAngleLength () const
	Returns the length of line over which the line's direction is averaged when calculating individual label angles.

const QgsMapUnitScale &	averageAngleMapUnitScale () const
	Returns the map unit scale for the length over which the line's direction is averaged when calculating individual label angles.

Qgis::RenderUnit	averageAngleUnit () const
	Returns the unit for the length over which the line's direction is averaged when calculating individual label angles.

QgsLinearReferencingSymbolLayer *	clone () const override
	Shall be reimplemented by subclasses to create a deep copy of the instance.

Qgis::SymbolLayerFlags	flags () const override
	Returns flags which control the symbol layer's behavior.

double	interval () const
	Returns the interval between labels.

QPointF	labelOffset () const
	Returns the offset between the line and linear referencing labels.

const QgsMapUnitScale &	labelOffsetMapUnitScale () const
	Returns the map unit scale used for calculating the offset between the line and linear referencing labels.

Qgis::RenderUnit	labelOffsetUnit () const
	Returns the unit used for the offset between the line and linear referencing labels.

Qgis::LinearReferencingLabelSource	labelSource () const
	Returns the label source, which dictates what quantity to use for the labels shown.

QString	layerType () const override
	Returns a string that represents this layer type.

QgsNumericFormat *	numericFormat () const
	Returns the numeric format used to format the labels for the layer.

Qgis::LinearReferencingPlacement	placement () const
	Returns the placement mode for the labels.

QVariantMap	properties () const override
	Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

void	renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context) override
	Renders the line symbol layer along the line joining points, using the given render context.

bool	rotateLabels () const
	Returns `true` if the labels and symbols are to 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 label 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 label angles.

void	setAverageAngleUnit (Qgis::RenderUnit unit)
	Sets the unit for the length over which the line's direction is averaged when calculating individual label angles.

void	setInterval (double interval)
	Sets the interval between labels.

void	setLabelOffset (const QPointF &offset)
	Sets the offset between the line and linear referencing labels.

void	setLabelOffsetMapUnitScale (const QgsMapUnitScale &scale)
	Sets the map unit scale used for calculating the offset between the line and linear referencing labels.

void	setLabelOffsetUnit (Qgis::RenderUnit unit)
	Sets the unit used for the offset between the line and linear referencing labels.

void	setLabelSource (Qgis::LinearReferencingLabelSource source)
	Sets the label source, which dictates what quantity to use for the labels shown.

void	setNumericFormat (QgsNumericFormat *format)
	Sets the numeric format used to format the labels for the layer.

void	setPlacement (Qgis::LinearReferencingPlacement placement)
	Sets the placement mode for the labels.

void	setRotateLabels (bool rotate)
	Sets whether the labels and symbols should be rotated to match their line segment orientation.

void	setShowMarker (bool show)
	Sets whether a marker symbol should be shown corresponding to the labeled point on line.

void	setSkipMultiplesOf (double multiple)
	Sets the multiple distance to skip labels for.

bool	setSubSymbol (QgsSymbol *symbol) override
	Sets layer's subsymbol. takes ownership of the passed symbol.

void	setTextFormat (const QgsTextFormat &format)
	Sets the text format used to render the layer.

bool	showMarker () const
	Returns `true` if a marker symbol should be shown corresponding to the labeled point on line.

double	skipMultiplesOf () const
	Returns the multiple distance to skip labels for.

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.

QgsSymbol *	subSymbol () override
	Returns the symbol's sub symbol, if present.

QgsTextFormat	textFormat () const
	Returns the text format used to render the layer.

Public Member Functions inherited from QgsLineSymbolLayer
	QgsLineSymbolLayer (const QgsLineSymbolLayer &other)=delete

void	drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override

double	dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
	Gets line width.

QgsMapUnitScale	mapUnitScale () const override

double	offset () const
	Returns the line's offset.

const QgsMapUnitScale &	offsetMapUnitScale () const
	Returns the map unit scale for the line's offset.

Qgis::RenderUnit	offsetUnit () const
	Returns the units for the line's offset.

QgsLineSymbolLayer &	operator= (const QgsLineSymbolLayer &other)=delete

Qgis::RenderUnit	outputUnit () const override
	Returns the units to use for sizes and widths within the symbol layer.

virtual void	renderPolygonStroke (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context)
	Renders the line symbol layer along the outline of polygon, using the given render context.

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	setMapUnitScale (const QgsMapUnitScale &scale) override

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	setOutputUnit (Qgis::RenderUnit unit) override
	Sets the units to use for sizes and widths within the symbol layer.

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.

virtual void	setWidth (double width)
	Sets the width of the line symbol layer.

void	setWidthMapUnitScale (const QgsMapUnitScale &scale)

void	setWidthUnit (Qgis::RenderUnit unit)
	Sets the units for the line's width.

virtual double	width () const
	Returns the estimated width for the line symbol layer.

virtual double	width (const QgsRenderContext &context) const
	Returns the line symbol layer width, in painter units.

const QgsMapUnitScale &	widthMapUnitScale () const

Qgis::RenderUnit	widthUnit () const
	Returns the units for the line's width.

Public Member Functions inherited from QgsSymbolLayer
	QgsSymbolLayer (const QgsSymbolLayer &other)=delete

virtual	~QgsSymbolLayer ()

virtual bool	canCauseArtifactsBetweenAdjacentTiles () const
	Returns `true` if the symbol layer rendering can cause visible artifacts across a single feature when the feature is rendered as a series of adjacent map tiles each containing a portion of the feature's geometry.

virtual QColor	color () const
	Returns the "representative" color of the symbol layer.

QgsPropertyCollection &	dataDefinedProperties ()
	Returns a reference to the symbol layer's property collection, used for data defined overrides.

const QgsPropertyCollection &	dataDefinedProperties () 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 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.

virtual QColor	fillColor () const
	Returns the fill color for the symbol layer.

virtual bool	hasDataDefinedProperties () const
	Returns `true` if the symbol layer (or any of its sub-symbols) contains data defined properties.

QString	id () const
	Returns symbol layer identifier This id is unique in the whole project.

bool	installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF())
	When rendering, install masks on context painter.

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< QgsSymbolLayerReference >	masks () const
	Returns masks defined by this symbol layer.

virtual QString	ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const

QgsSymbolLayer &	operator= (const QgsSymbolLayer &other)=delete

QgsPaintEffect *	paintEffect () 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.

virtual void	setColor (const QColor &color)
	Sets the "representative" color for the symbol layer.

void	setDataDefinedProperties (const QgsPropertyCollection &collection)
	Sets the symbol layer's property collection, used for data defined overrides.

virtual void	setDataDefinedProperty (Property key, const QgsProperty &property)
	Sets a data defined property for the layer.

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 void	startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called before the layer will be rendered for a particular feature.

virtual void	stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
	Called after the layer has been rendered for a particular feature.

virtual QColor	strokeColor () const
	Returns the stroke color for the symbol layer.

virtual void	toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
	Saves the symbol layer as SLD.

Qgis::SymbolType	type () const

virtual QSet< QString >	usedAttributes (const QgsRenderContext &context) const
	Returns the set of attributes referenced by the layer.

Qgis::SymbolLayerUserFlags	userFlags () const
	Returns user-controlled flags which control the symbol layer's behavior.

virtual bool	usesMapUnits () const
	Returns `true` if the symbol layer has any components which use map unit based sizes.

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 QgsSymbolLayer *	create (const QVariantMap &properties=QVariantMap())
	Creates a new QgsLinearReferencingSymbolLayer, using the specified properties.

Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition &	propertyDefinitions ()
	Returns the symbol layer property definitions.

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 , SkipMultiples , ShowMarker }
	Data definable properties. More...

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	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 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< QgsPaintEffect >	mPaintEffect

int	mRenderingPass = 0

Qgis::SymbolType	mType

Qgis::SymbolLayerUserFlags	mUserFlags
	User controlled flags.

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 used for decorating accordingly to linear referencing.

This symbol layer type allows placing text labels at regular intervals along a line (or at positions corresponding to existing vertices). Positions can be calculated using Cartesian distances, or interpolated from z or m values.

Since: QGIS 3.40

Definition at line 35 of file qgslinearreferencingsymbollayer.h.

Constructor & Destructor Documentation

◆ QgsLinearReferencingSymbolLayer()

QgsLinearReferencingSymbolLayer::QgsLinearReferencingSymbolLayer ( )

Definition at line 122 of file qgslinearreferencingsymbollayer.cpp.

◆ ~QgsLinearReferencingSymbolLayer()

QgsLinearReferencingSymbolLayer::~QgsLinearReferencingSymbolLayer ( )

overridedefault

Member Function Documentation

◆ averageAngleLength()

double QgsLinearReferencingSymbolLayer::averageAngleLength ( ) const

inline

Returns the length of line over which the line's direction is averaged when calculating individual label angles.

Longer lengths smooth out angles from jagged lines to a greater extent.

Units are retrieved through averageAngleUnit()

See also: setAverageAngleLength(); averageAngleUnit(); averageAngleMapUnitScale()

Definition at line 250 of file qgslinearreferencingsymbollayer.h.

◆ averageAngleMapUnitScale()

const QgsMapUnitScale & QgsLinearReferencingSymbolLayer::averageAngleMapUnitScale ( ) const

inline

Returns the map unit scale for the length over which the line's direction is averaged when calculating individual label angles.

See also: setAverageAngleMapUnitScale(); averageAngleLength(); averageAngleUnit()

Definition at line 302 of file qgslinearreferencingsymbollayer.h.

◆ averageAngleUnit()

Qgis::RenderUnit QgsLinearReferencingSymbolLayer::averageAngleUnit ( ) const

inline

Returns the unit for the length over which the line's direction is averaged when calculating individual label angles.

See also: setAverageAngleUnit(); averageAngleLength(); averageAngleMapUnitScale()

Definition at line 282 of file qgslinearreferencingsymbollayer.h.

◆ clone()

QgsLinearReferencingSymbolLayer * QgsLinearReferencingSymbolLayer::clone ( ) const

overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 199 of file qgslinearreferencingsymbollayer.cpp.

◆ create()

QgsSymbolLayer * QgsLinearReferencingSymbolLayer::create ( const QVariantMap & properties = QVariantMap() )

static

Creates a new QgsLinearReferencingSymbolLayer, using the specified properties.

The caller takes ownership of the returned object.

Definition at line 130 of file qgslinearreferencingsymbollayer.cpp.

◆ flags()

Qgis::SymbolLayerFlags QgsLinearReferencingSymbolLayer::flags ( ) const

overridevirtual

Returns flags which control the symbol layer's behavior.

Since: QGIS 3.22

Reimplemented from QgsSymbolLayer.

Definition at line 297 of file qgslinearreferencingsymbollayer.cpp.

◆ interval()

double QgsLinearReferencingSymbolLayer::interval ( ) const

Returns the interval between labels.

Units are always in the original layer CRS units.

See also: setInterval()

Definition at line 1089 of file qgslinearreferencingsymbollayer.cpp.

◆ labelOffset()

QPointF QgsLinearReferencingSymbolLayer::labelOffset ( ) const

inline

Returns the offset between the line and linear referencing labels.

The unit for the offset is retrievable via labelOffsetUnit().

See also: setLabelOffset(); labelOffsetUnit()

Definition at line 152 of file qgslinearreferencingsymbollayer.h.

◆ labelOffsetMapUnitScale()

const QgsMapUnitScale & QgsLinearReferencingSymbolLayer::labelOffsetMapUnitScale ( ) const

inline

Returns the map unit scale used for calculating the offset between the line and linear referencing labels.

See also: setLabelOffsetMapUnitScale()

Definition at line 185 of file qgslinearreferencingsymbollayer.h.

◆ labelOffsetUnit()

Qgis::RenderUnit QgsLinearReferencingSymbolLayer::labelOffsetUnit ( ) const

inline

Returns the unit used for the offset between the line and linear referencing labels.

See also: setLabelOffsetUnit(); labelOffset()

Definition at line 170 of file qgslinearreferencingsymbollayer.h.

◆ labelSource()

Qgis::LinearReferencingLabelSource QgsLinearReferencingSymbolLayer::labelSource ( ) const

Returns the label source, which dictates what quantity to use for the labels shown.

See also: setLabelSource()

Definition at line 1133 of file qgslinearreferencingsymbollayer.cpp.

◆ layerType()

QString QgsLinearReferencingSymbolLayer::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 292 of file qgslinearreferencingsymbollayer.cpp.

◆ numericFormat()

QgsNumericFormat * QgsLinearReferencingSymbolLayer::numericFormat ( ) const

Returns the numeric format used to format the labels for the layer.

See also: setNumericFormat()

Definition at line 1079 of file qgslinearreferencingsymbollayer.cpp.

◆ placement()

Qgis::LinearReferencingPlacement QgsLinearReferencingSymbolLayer::placement ( ) const

Returns the placement mode for the labels.

See also: setPlacement()

Definition at line 1123 of file qgslinearreferencingsymbollayer.cpp.

◆ properties()

QVariantMap QgsLinearReferencingSymbolLayer::properties ( ) const

overridevirtual

Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.

This is used to serialize a symbol layer perstistently.

Implements QgsSymbolLayer.

Definition at line 226 of file qgslinearreferencingsymbollayer.cpp.

◆ renderPolyline()

void QgsLinearReferencingSymbolLayer::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 383 of file qgslinearreferencingsymbollayer.cpp.

◆ rotateLabels()

bool QgsLinearReferencingSymbolLayer::rotateLabels ( ) const

inline

Returns true if the labels and symbols are to be rotated to match their line segment orientation.

See also: setRotateLabels()

Definition at line 135 of file qgslinearreferencingsymbollayer.h.

◆ setAverageAngleLength()

void QgsLinearReferencingSymbolLayer::setAverageAngleLength ( double length )

inline

Sets the length of line over which the line's direction is averaged when calculating individual label angles.

Longer lengths smooth out angles from jagged lines to a greater extent.

Units are set through setAverageAngleUnit()

See also: averageAngleLength(); setAverageAngleUnit(); setAverageAngleMapUnitScale()

Definition at line 262 of file qgslinearreferencingsymbollayer.h.

◆ setAverageAngleMapUnitScale()

void QgsLinearReferencingSymbolLayer::setAverageAngleMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale for the length over which the line's direction is averaged when calculating individual label angles.

See also: averageAngleMapUnitScale(); setAverageAngleLength(); setAverageAngleUnit()

Definition at line 292 of file qgslinearreferencingsymbollayer.h.

◆ setAverageAngleUnit()

void QgsLinearReferencingSymbolLayer::setAverageAngleUnit ( Qgis::RenderUnit unit )

inline

Sets the unit for the length over which the line's direction is averaged when calculating individual label angles.

See also: averageAngleUnit(); setAverageAngleLength(); setAverageAngleMapUnitScale()

Definition at line 272 of file qgslinearreferencingsymbollayer.h.

◆ setInterval()

void QgsLinearReferencingSymbolLayer::setInterval ( double interval )

Sets the interval between labels.

Units are always in the original layer CRS units.

See also: setInterval()

Definition at line 1094 of file qgslinearreferencingsymbollayer.cpp.

◆ setLabelOffset()

void QgsLinearReferencingSymbolLayer::setLabelOffset ( const QPointF & offset )

inline

Sets the offset between the line and linear referencing labels.

The unit for the offset is set via setLabelOffsetUnit().

See also: labelOffset(); setLabelOffsetUnit()

Definition at line 162 of file qgslinearreferencingsymbollayer.h.

◆ setLabelOffsetMapUnitScale()

void QgsLinearReferencingSymbolLayer::setLabelOffsetMapUnitScale ( const QgsMapUnitScale & scale )

inline

Sets the map unit scale used for calculating the offset between the line and linear referencing labels.

See also: labelOffsetMapUnitScale()

Definition at line 192 of file qgslinearreferencingsymbollayer.h.

◆ setLabelOffsetUnit()

void QgsLinearReferencingSymbolLayer::setLabelOffsetUnit ( Qgis::RenderUnit unit )

inline

Sets the unit used for the offset between the line and linear referencing labels.

See also: labelOffsetUnit(); setLabelOffset()

Definition at line 178 of file qgslinearreferencingsymbollayer.h.

◆ setLabelSource()

void QgsLinearReferencingSymbolLayer::setLabelSource ( Qgis::LinearReferencingLabelSource source )

Sets the label source, which dictates what quantity to use for the labels shown.

See also: labelSource()

Definition at line 1138 of file qgslinearreferencingsymbollayer.cpp.

◆ setNumericFormat()

void QgsLinearReferencingSymbolLayer::setNumericFormat ( QgsNumericFormat * format )

Sets the numeric format used to format the labels for the layer.

Ownership of format is transferred to the layer.

See also: numericFormat()

Definition at line 1084 of file qgslinearreferencingsymbollayer.cpp.

◆ setPlacement()

void QgsLinearReferencingSymbolLayer::setPlacement ( Qgis::LinearReferencingPlacement placement )

Sets the placement mode for the labels.

See also: placement()

Definition at line 1128 of file qgslinearreferencingsymbollayer.cpp.

◆ setRotateLabels()

void QgsLinearReferencingSymbolLayer::setRotateLabels ( bool rotate )

inline

Sets whether the labels and symbols should be rotated to match their line segment orientation.

See also: rotateLabels()

Definition at line 142 of file qgslinearreferencingsymbollayer.h.

◆ setShowMarker()

void QgsLinearReferencingSymbolLayer::setShowMarker ( bool show )

Sets whether a marker symbol should be shown corresponding to the labeled point on line.

The marker symbol is set using setSubSymbol()

See also: showMarker()

Definition at line 1114 of file qgslinearreferencingsymbollayer.cpp.

◆ setSkipMultiplesOf()

void QgsLinearReferencingSymbolLayer::setSkipMultiplesOf ( double multiple )

Sets the multiple distance to skip labels for.

If this value is non-zero, then any labels which are integer multiples of the returned value will be skipped. This allows creation of advanced referencing styles where a single QgsSymbol has multiple QgsLinearReferencingSymbolLayer symbol layers, eg allowing labeling every 100 in a normal font and every 1000 in a bold, larger font.

See also: skipMultiplesOf()

Definition at line 1104 of file qgslinearreferencingsymbollayer.cpp.

◆ setSubSymbol()

bool QgsLinearReferencingSymbolLayer::setSubSymbol ( QgsSymbol * symbol )

overridevirtual

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

Reimplemented from QgsSymbolLayer.

Definition at line 308 of file qgslinearreferencingsymbollayer.cpp.

◆ setTextFormat()

void QgsLinearReferencingSymbolLayer::setTextFormat ( const QgsTextFormat & format )

Sets the text format used to render the layer.

See also: textFormat()

Definition at line 1074 of file qgslinearreferencingsymbollayer.cpp.

◆ showMarker()

bool QgsLinearReferencingSymbolLayer::showMarker ( ) const

Returns true if a marker symbol should be shown corresponding to the labeled point on line.

The marker symbol is set using setSubSymbol()

See also: setShowMarker()

Definition at line 1109 of file qgslinearreferencingsymbollayer.cpp.

◆ skipMultiplesOf()

double QgsLinearReferencingSymbolLayer::skipMultiplesOf ( ) const

Returns the multiple distance to skip labels for.

If this value is non-zero, then any labels which are integer multiples of the returned value will be skipped. This allows creation of advanced referencing styles where a single QgsSymbol has multiple QgsLinearReferencingSymbolLayer symbol layers, eg allowing labeling every 100 in a normal font and every 1000 in a bold, larger font.

See also: setSkipMultiplesOf()

Definition at line 1099 of file qgslinearreferencingsymbollayer.cpp.

◆ startRender()

void QgsLinearReferencingSymbolLayer::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 319 of file qgslinearreferencingsymbollayer.cpp.

◆ stopRender()

void QgsLinearReferencingSymbolLayer::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 340 of file qgslinearreferencingsymbollayer.cpp.

◆ subSymbol()

QgsSymbol * QgsLinearReferencingSymbolLayer::subSymbol ( )

overridevirtual

Returns the symbol's sub symbol, if present.

Reimplemented from QgsSymbolLayer.

Definition at line 303 of file qgslinearreferencingsymbollayer.cpp.

◆ textFormat()

QgsTextFormat QgsLinearReferencingSymbolLayer::textFormat ( ) const

Returns the text format used to render the layer.

See also: setTextFormat()

Definition at line 1069 of file qgslinearreferencingsymbollayer.cpp.

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

/build/qgis-3.39.0+git20240920+d85f3c2a281+99sid/src/core/symbology/qgslinearreferencingsymbollayer.h
/build/qgis-3.39.0+git20240920+d85f3c2a281+99sid/src/core/symbology/qgslinearreferencingsymbollayer.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ QgsLinearReferencingSymbolLayer()

◆ ~QgsLinearReferencingSymbolLayer()

Member Function Documentation

◆ averageAngleLength()

◆ averageAngleMapUnitScale()

◆ averageAngleUnit()

◆ clone()

◆ create()

◆ flags()

◆ interval()

◆ labelOffset()

◆ labelOffsetMapUnitScale()

◆ labelOffsetUnit()

◆ labelSource()

◆ layerType()

◆ numericFormat()

◆ placement()

◆ properties()

◆ renderPolyline()

◆ rotateLabels()

◆ setAverageAngleLength()

◆ setAverageAngleMapUnitScale()

◆ setAverageAngleUnit()

◆ setInterval()

◆ setLabelOffset()

◆ setLabelOffsetMapUnitScale()

◆ setLabelOffsetUnit()

◆ setLabelSource()

◆ setNumericFormat()

◆ setPlacement()

◆ setRotateLabels()

◆ setShowMarker()

◆ setSkipMultiplesOf()

◆ setSubSymbol()

◆ setTextFormat()

◆ showMarker()

◆ skipMultiplesOf()

◆ startRender()

◆ stopRender()

◆ subSymbol()

◆ textFormat()