QGIS API Documentation  3.23.0-Master (eb871beae0)
Public Member Functions | Static Public Member Functions | List of all members
QgsSimpleLineSymbolLayer Class Reference

A simple line symbol layer, which renders lines using a line in a variety of styles (e.g. More...

#include <qgslinesymbollayer.h>

Inheritance diagram for QgsSimpleLineSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsSimpleLineSymbolLayer (const QColor &color=DEFAULT_SIMPLELINE_COLOR, double width=DEFAULT_SIMPLELINE_WIDTH, Qt::PenStyle penStyle=DEFAULT_SIMPLELINE_PENSTYLE)
 Constructor for QgsSimpleLineSymbolLayer. More...
 
 ~QgsSimpleLineSymbolLayer () override
 
bool alignDashPattern () const
 Returns true if dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element. 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...
 
QgsSimpleLineSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
const QgsMapUnitScalecustomDashPatternMapUnitScale () const
 Returns the map unit scale for lengths used in the custom dash pattern. More...
 
QgsUnitTypes::RenderUnit customDashPatternUnit () const
 Returns the units for lengths used in the custom dash pattern. More...
 
QVector< qreal > customDashVector () const
 Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern. More...
 
double dashPatternOffset () const
 Returns the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at. More...
 
const QgsMapUnitScaledashPatternOffsetMapUnitScale () const
 Returns the map unit scale for the dash pattern offset value. More...
 
QgsUnitTypes::RenderUnit dashPatternOffsetUnit () const
 Returns the units for the dash pattern offset. More...
 
bool drawInsidePolygon () const
 Returns true if the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away. More...
 
QColor dxfColor (QgsSymbolRenderContext &context) const override
 Gets color. More...
 
QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const override
 Gets dash pattern. More...
 
double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets offset. More...
 
Qt::PenStyle dxfPenStyle () const override
 Gets pen style. More...
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width. 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...
 
QString layerType () const override
 Returns a string that represents this layer type. More...
 
QgsMapUnitScale mapUnitScale () const override
 
QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const override
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
Qt::PenCapStyle penCapStyle () const
 Returns the pen cap style used to render the line (e.g. More...
 
Qt::PenJoinStyle penJoinStyle () const
 Returns the pen join style used to render the line (e.g. More...
 
Qt::PenStyle penStyle () const
 Returns the pen style used to render the line (e.g. 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) override
 Renders the line symbol layer along the outline of polygon, using the given render context. 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...
 
void setAlignDashPattern (bool enabled)
 Sets whether dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element. More...
 
void setCustomDashPatternMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for lengths used in the custom dash pattern. More...
 
void setCustomDashPatternUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for lengths used in the custom dash pattern. More...
 
void setCustomDashVector (const QVector< qreal > &vector)
 Sets the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern. More...
 
void setDashPatternOffset (double offset)
 Sets the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at. More...
 
void setDashPatternOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the dash pattern offset. More...
 
void setDashPatternOffsetUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the dash pattern offset. More...
 
void setDrawInsidePolygon (bool drawInsidePolygon)
 Sets whether the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away. More...
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOutputUnit (QgsUnitTypes::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer. More...
 
void setPenCapStyle (Qt::PenCapStyle style)
 Sets the pen cap style used to render the line (e.g. More...
 
void setPenJoinStyle (Qt::PenJoinStyle style)
 Sets the pen join style used to render the line (e.g. More...
 
void setPenStyle (Qt::PenStyle style)
 Sets the pen style used to render the line (e.g. More...
 
void setTrimDistanceEnd (double distance)
 Sets the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end. More...
 
void setTrimDistanceEndMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the trim distance for the end of the line. More...
 
void setTrimDistanceEndUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the trim distance for the end of the line. More...
 
void setTrimDistanceStart (double distance)
 Sets the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start. More...
 
void setTrimDistanceStartMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the trim distance for the start of the line. More...
 
void setTrimDistanceStartUnit (QgsUnitTypes::RenderUnit unit)
 Sets the unit for the trim distance for the start of the line. More...
 
void setTweakDashPatternOnCorners (bool enabled)
 Sets whether dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner. More...
 
void setUseCustomDashPattern (bool b)
 Sets whether the line uses a custom dash pattern. 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...
 
void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override
 Saves the symbol layer as SLD. More...
 
double trimDistanceEnd () const
 Returns the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end. More...
 
const QgsMapUnitScaletrimDistanceEndMapUnitScale () const
 Returns the map unit scale for the trim distance for the end of the line. More...
 
QgsUnitTypes::RenderUnit trimDistanceEndUnit () const
 Returns the unit for the trim distance for the end of the line. More...
 
double trimDistanceStart () const
 Returns the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start. More...
 
const QgsMapUnitScaletrimDistanceStartMapUnitScale () const
 Returns the map unit scale for the trim distance for the start of the line. More...
 
QgsUnitTypes::RenderUnit trimDistanceStartUnit () const
 Returns the unit for the trim distance for the start of the line. More...
 
bool tweakDashPatternOnCorners () const
 Returns true if dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner. More...
 
bool useCustomDashPattern () const
 Returns true if the line uses a custom dash pattern. More...
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes. More...
 
- Public Member Functions inherited from QgsLineSymbolLayer
 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 QgsMapUnitScaleoffsetMapUnitScale () 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...
 
QgsLineSymbolLayeroperator= (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...
 
virtual void setWidth (double width)
 Sets the width of the line symbol layer. More...
 
void setWidthMapUnitScale (const QgsMapUnitScale &scale)
 
void setWidthUnit (QgsUnitTypes::RenderUnit unit)
 Sets the units for the line's width. More...
 
virtual double width () const
 Returns the estimated width for the line symbol layer. More...
 
virtual double width (const QgsRenderContext &context) const
 Returns the line symbol layer width, in painter units. More...
 
const QgsMapUnitScalewidthMapUnitScale () const
 
QgsUnitTypes::RenderUnit widthUnit () const
 Returns the units for the line's width. More...
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
virtual ~QgsSymbolLayer ()
 
virtual QColor color () const
 The fill color. More...
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides. More...
 
const QgsPropertyCollectiondataDefinedProperties () 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...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual QColor fillColor () const
 Gets fill color. More...
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior. More...
 
virtual bool hasDataDefinedProperties () const
 Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. 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< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer. More...
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied. More...
 
QgsPaintEffectpaintEffect () 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...
 
virtual void setColor (const QColor &color)
 The fill color. More...
 
void setDataDefinedProperties (const QgsPropertyCollection &collection)
 Sets the symbol layer's property collection, used for data defined overrides. More...
 
virtual void setDataDefinedProperty (Property key, const QgsProperty &property)
 Sets a data defined property for the layer. More...
 
void setEnabled (bool enabled)
 Sets whether symbol layer is enabled and should be drawn. More...
 
virtual void setFillColor (const QColor &color)
 Set fill color. More...
 
void setLocked (bool locked)
 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)
 Set stroke color. More...
 
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol. More...
 
virtual void startFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called before the layer will be rendered for a particular feature. More...
 
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature. More...
 
virtual QColor strokeColor () const
 Gets stroke color. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
Qgis::SymbolType type () const
 
virtual QSet< QString > usedAttributes (const QgsRenderContext &context) const
 Returns the set of attributes referenced by the layer. More...
 
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 QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsSimpleLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsSimpleLineSymbolLayer::properties() ). More...
 
static QgsSymbolLayercreateFromSld (QDomElement &element)
 Creates a new QgsSimpleLineSymbolLayer from an SLD XML DOM element. More...
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 

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  Property {
  PropertySize = 0 , PropertyAngle , PropertyName , PropertyFillColor ,
  PropertyStrokeColor , PropertyStrokeWidth , PropertyStrokeStyle , PropertyOffset ,
  PropertyCharacter , PropertyWidth , PropertyHeight , PropertyPreserveAspectRatio ,
  PropertyFillStyle , PropertyJoinStyle , PropertySecondaryColor , PropertyLineAngle ,
  PropertyLineDistance , PropertyGradientType , PropertyCoordinateMode , PropertyGradientSpread ,
  PropertyGradientReference1X , PropertyGradientReference1Y , PropertyGradientReference2X , PropertyGradientReference2Y ,
  PropertyGradientReference1IsCentroid , PropertyGradientReference2IsCentroid , PropertyBlurRadius , PropertyShapeburstUseWholeShape ,
  PropertyShapeburstMaxDistance , PropertyShapeburstIgnoreRings , PropertyFile , PropertyDistanceX ,
  PropertyDistanceY , PropertyDisplacementX , PropertyDisplacementY , PropertyOpacity ,
  PropertyCustomDash , PropertyCapStyle , PropertyPlacement , PropertyInterval ,
  PropertyOffsetAlongLine , PropertyAverageAngleLength , PropertyHorizontalAnchor , PropertyVerticalAnchor ,
  PropertyLayerEnabled , PropertyArrowWidth , PropertyArrowStartWidth , PropertyArrowHeadLength ,
  PropertyArrowHeadThickness , PropertyArrowHeadType , PropertyArrowType , PropertyOffsetX ,
  PropertyOffsetY , PropertyPointCount , PropertyRandomSeed , PropertyClipPoints ,
  PropertyDensityArea , PropertyFontFamily , PropertyFontStyle , PropertyDashPatternOffset ,
  PropertyTrimStart , PropertyTrimEnd , PropertyLineStartWidthValue , PropertyLineEndWidthValue ,
  PropertyLineStartColorValue , PropertyLineEndColorValue , PropertyMarkerClipping , PropertyRandomOffsetX ,
  PropertyRandomOffsetY , PropertyLineClipping
}
 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. 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 inherited from QgsLineSymbolLayer
double mOffset = 0
 
QgsMapUnitScale mOffsetMapUnitScale
 
QgsUnitTypes::RenderUnit mOffsetUnit = QgsUnitTypes::RenderMillimeters
 
RenderRingFilter mRingFilter = AllRings
 
double mWidth = 0
 
QgsMapUnitScale mWidthMapUnitScale
 
QgsUnitTypes::RenderUnit mWidthUnit = QgsUnitTypes::RenderMillimeters
 
- Protected Attributes inherited from QgsSymbolLayer
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< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 
- Static Protected Attributes inherited from QgsSymbolLayer
static const bool SELECT_FILL_BORDER = false
 Whether fill styles for selected features also highlight symbol stroke. More...
 
static const bool SELECT_FILL_STYLE = false
 Whether fill styles for selected features uses symbol layer style. More...
 
static const bool SELECTION_IS_OPAQUE = true
 Whether styles for selected features ignore symbol alpha. More...
 

Detailed Description

A simple line symbol layer, which renders lines using a line in a variety of styles (e.g.

solid, dotted, dashed).

Definition at line 43 of file qgslinesymbollayer.h.

Constructor & Destructor Documentation

◆ QgsSimpleLineSymbolLayer()

QgsSimpleLineSymbolLayer::QgsSimpleLineSymbolLayer ( const QColor &  color = DEFAULT_SIMPLELINE_COLOR,
double  width = DEFAULT_SIMPLELINE_WIDTH,
Qt::PenStyle  penStyle = DEFAULT_SIMPLELINE_PENSTYLE 
)

Constructor for QgsSimpleLineSymbolLayer.

Creates a simple line symbol in the specified color, width (in millimeters) and penStyle.

Definition at line 44 of file qgslinesymbollayer.cpp.

◆ ~QgsSimpleLineSymbolLayer()

QgsSimpleLineSymbolLayer::~QgsSimpleLineSymbolLayer ( )
overridedefault

Member Function Documentation

◆ alignDashPattern()

bool QgsSimpleLineSymbolLayer::alignDashPattern ( ) const

Returns true if dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element.

See also
setAlignDashPattern()
tweakDashPatternOnCorners()
Since
QGIS 3.16

Definition at line 1116 of file qgslinesymbollayer.cpp.

◆ canCauseArtifactsBetweenAdjacentTiles()

bool QgsSimpleLineSymbolLayer::canCauseArtifactsBetweenAdjacentTiles ( ) const
overridevirtual

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.

The default implementation returns false.

Since
QGIS 3.18

Reimplemented from QgsSymbolLayer.

Definition at line 1111 of file qgslinesymbollayer.cpp.

◆ clone()

QgsSimpleLineSymbolLayer * QgsSimpleLineSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 537 of file qgslinesymbollayer.cpp.

◆ create()

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

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

Definition at line 97 of file qgslinesymbollayer.cpp.

◆ createFromSld()

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

Creates a new QgsSimpleLineSymbolLayer from an SLD XML DOM element.

Definition at line 618 of file qgslinesymbollayer.cpp.

◆ customDashPatternMapUnitScale()

const QgsMapUnitScale& QgsSimpleLineSymbolLayer::customDashPatternMapUnitScale ( ) const
inline

Returns the map unit scale for lengths used in the custom dash pattern.

See also
setCustomDashPatternMapUnitScale()

Definition at line 169 of file qgslinesymbollayer.h.

◆ customDashPatternUnit()

QgsUnitTypes::RenderUnit QgsSimpleLineSymbolLayer::customDashPatternUnit ( ) const
inline

Returns the units for lengths used in the custom dash pattern.

See also
setCustomDashPatternUnit()

Definition at line 163 of file qgslinesymbollayer.h.

◆ customDashVector()

QVector<qreal> QgsSimpleLineSymbolLayer::customDashVector ( ) const
inline

Returns the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.

Units for the vector are specified by customDashPatternUnit()

This setting is only used when useCustomDashPattern() returns true.

See also
setCustomDashVector()
customDashPatternUnit()
useCustomDashPattern()

Definition at line 189 of file qgslinesymbollayer.h.

◆ dashPatternOffset()

double QgsSimpleLineSymbolLayer::dashPatternOffset ( ) const
inline

Returns the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.

Offset units can be retrieved by calling dashPatternOffsetUnit().

See also
setDashPatternOffset()
dashPatternOffsetUnit()
dashPatternOffsetMapUnitScale()
Since
QGIS 3.16

Definition at line 217 of file qgslinesymbollayer.h.

◆ dashPatternOffsetMapUnitScale()

const QgsMapUnitScale& QgsSimpleLineSymbolLayer::dashPatternOffsetMapUnitScale ( ) const
inline

Returns the map unit scale for the dash pattern offset value.

See also
setDashPatternOffsetMapUnitScale()
dashPatternOffsetUnit()
dashPatternOffset()
Since
QGIS 3.16

Definition at line 264 of file qgslinesymbollayer.h.

◆ dashPatternOffsetUnit()

QgsUnitTypes::RenderUnit QgsSimpleLineSymbolLayer::dashPatternOffsetUnit ( ) const
inline

Returns the units for the dash pattern offset.

See also
setDashPatternOffsetUnit()
dashPatternOffset()
dashPatternOffsetMapUnitScale()
Since
QGIS 3.16

Definition at line 253 of file qgslinesymbollayer.h.

◆ drawInsidePolygon()

bool QgsSimpleLineSymbolLayer::drawInsidePolygon ( ) const
inline

Returns true if the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away.

This setting only has an effect when the line symbol is being used to render polygon rings.

See also
setDrawInsidePolygon()

Definition at line 442 of file qgslinesymbollayer.h.

◆ dxfColor()

QColor QgsSimpleLineSymbolLayer::dxfColor ( QgsSymbolRenderContext context) const
overridevirtual

Gets color.

Reimplemented from QgsSymbolLayer.

Definition at line 1101 of file qgslinesymbollayer.cpp.

◆ dxfCustomDashPattern()

QVector< qreal > QgsSimpleLineSymbolLayer::dxfCustomDashPattern ( QgsUnitTypes::RenderUnit unit) const
overridevirtual

Gets dash pattern.

Reimplemented from QgsSymbolLayer.

Definition at line 1073 of file qgslinesymbollayer.cpp.

◆ dxfOffset()

double QgsSimpleLineSymbolLayer::dxfOffset ( const QgsDxfExport e,
QgsSymbolRenderContext context 
) const
overridevirtual

Gets offset.

Reimplemented from QgsSymbolLayer.

Definition at line 1136 of file qgslinesymbollayer.cpp.

◆ dxfPenStyle()

Qt::PenStyle QgsSimpleLineSymbolLayer::dxfPenStyle ( ) const
overridevirtual

Gets pen style.

Reimplemented from QgsSymbolLayer.

Definition at line 1079 of file qgslinesymbollayer.cpp.

◆ dxfWidth()

double QgsSimpleLineSymbolLayer::dxfWidth ( const QgsDxfExport e,
QgsSymbolRenderContext context 
) const
overridevirtual

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 1084 of file qgslinesymbollayer.cpp.

◆ estimateMaxBleed()

double QgsSimpleLineSymbolLayer::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 1059 of file qgslinesymbollayer.cpp.

◆ layerType()

QString QgsSimpleLineSymbolLayer::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 227 of file qgslinesymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsSimpleLineSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 86 of file qgslinesymbollayer.cpp.

◆ ogrFeatureStyle()

QString QgsSimpleLineSymbolLayer::ogrFeatureStyle ( double  mmScaleFactor,
double  mapUnitScaleFactor 
) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 603 of file qgslinesymbollayer.cpp.

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsSimpleLineSymbolLayer::outputUnit ( ) const
overridevirtual

Returns 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.

Returns
output unit, or QgsUnitTypes::RenderUnknownUnit if the symbol layer contains mixed units
See also
setOutputUnit()

Reimplemented from QgsSymbolLayer.

Definition at line 62 of file qgslinesymbollayer.cpp.

◆ penCapStyle()

Qt::PenCapStyle QgsSimpleLineSymbolLayer::penCapStyle ( ) const
inline

Returns the pen cap style used to render the line (e.g.

flat, square, round, etc).

See also
setPenCapStyle()

Definition at line 128 of file qgslinesymbollayer.h.

◆ penJoinStyle()

Qt::PenJoinStyle QgsSimpleLineSymbolLayer::penJoinStyle ( ) const
inline

Returns the pen join style used to render the line (e.g.

miter, bevel, round, etc).

See also
setPenJoinStyle()

Definition at line 114 of file qgslinesymbollayer.h.

◆ penStyle()

Qt::PenStyle QgsSimpleLineSymbolLayer::penStyle ( ) const
inline

Returns the pen style used to render the line (e.g.

solid, dashed, etc).

See also
setPenStyle()

Definition at line 100 of file qgslinesymbollayer.h.

◆ properties()

QVariantMap QgsSimpleLineSymbolLayer::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 504 of file qgslinesymbollayer.cpp.

◆ renderPolygonStroke()

void QgsSimpleLineSymbolLayer::renderPolygonStroke ( const QPolygonF &  points,
const QVector< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
overridevirtual

Renders the line symbol layer along the outline of polygon, using the given render context.

The exterior ring of the polygon is specified in points. Optionally, interior rings are set via the rings argument.

See also
renderPolyline()

Reimplemented from QgsLineSymbolLayer.

Definition at line 283 of file qgslinesymbollayer.cpp.

◆ renderPolyline()

void QgsSimpleLineSymbolLayer::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 371 of file qgslinesymbollayer.cpp.

◆ setAlignDashPattern()

void QgsSimpleLineSymbolLayer::setAlignDashPattern ( bool  enabled)

Sets whether dash patterns should be aligned to the start and end of lines, by applying subtle tweaks to the pattern sizing in order to ensure that the end of a line is represented by a complete dash element.

See also
alignDashPattern()
setTweakDashPatternOnCorners()
Since
QGIS 3.16

Definition at line 1121 of file qgslinesymbollayer.cpp.

◆ setCustomDashPatternMapUnitScale()

void QgsSimpleLineSymbolLayer::setCustomDashPatternMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for lengths used in the custom dash pattern.

See also
customDashPatternMapUnitScale()

Definition at line 175 of file qgslinesymbollayer.h.

◆ setCustomDashPatternUnit()

void QgsSimpleLineSymbolLayer::setCustomDashPatternUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for lengths used in the custom dash pattern.

See also
customDashPatternUnit()

Definition at line 157 of file qgslinesymbollayer.h.

◆ setCustomDashVector()

void QgsSimpleLineSymbolLayer::setCustomDashVector ( const QVector< qreal > &  vector)
inline

Sets the custom dash vector, which is the pattern of alternating drawn/skipped lengths used while rendering a custom dash pattern.

Units for the vector are specified by customDashPatternUnit()

This setting is only used when useCustomDashPattern() returns true.

See also
customDashVector()
setCustomDashPatternUnit()
setUseCustomDashPattern()

Definition at line 203 of file qgslinesymbollayer.h.

◆ setDashPatternOffset()

void QgsSimpleLineSymbolLayer::setDashPatternOffset ( double  offset)
inline

Sets the dash pattern offset, which dictates how far along the dash pattern the pattern should start rendering at.

Offset units are set via setDashPatternOffsetUnit().

See also
dashPatternOffset()
setDashPatternOffsetUnit()
setDashPatternOffsetMapUnitScale()
Since
QGIS 3.16

Definition at line 231 of file qgslinesymbollayer.h.

◆ setDashPatternOffsetMapUnitScale()

void QgsSimpleLineSymbolLayer::setDashPatternOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the dash pattern offset.

See also
dashPatternOffsetMapUnitScale()
setDashPatternOffset()
setDashPatternOffsetUnit()
Since
QGIS 3.16

Definition at line 275 of file qgslinesymbollayer.h.

◆ setDashPatternOffsetUnit()

void QgsSimpleLineSymbolLayer::setDashPatternOffsetUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the dash pattern offset.

See also
dashPatternOffsetUnit()
setDashPatternOffset()
setDashPatternOffsetMapUnitScale()
Since
QGIS 3.16

Definition at line 242 of file qgslinesymbollayer.h.

◆ setDrawInsidePolygon()

void QgsSimpleLineSymbolLayer::setDrawInsidePolygon ( bool  drawInsidePolygon)
inline

Sets whether the line should only be drawn inside polygons, and any portion of the line which falls outside the polygon should be clipped away.

This setting only has an effect when the line symbol is being used to render polygon rings.

See also
drawInsidePolygon()

Definition at line 453 of file qgslinesymbollayer.h.

◆ setMapUnitScale()

void QgsSimpleLineSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 78 of file qgslinesymbollayer.cpp.

◆ setOutputUnit()

void QgsSimpleLineSymbolLayer::setOutputUnit ( QgsUnitTypes::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 QgsSymbolLayer.

Definition at line 54 of file qgslinesymbollayer.cpp.

◆ setPenCapStyle()

void QgsSimpleLineSymbolLayer::setPenCapStyle ( Qt::PenCapStyle  style)
inline

Sets the pen cap style used to render the line (e.g.

flat, square, round, etc).

See also
penCapStyle()

Definition at line 135 of file qgslinesymbollayer.h.

◆ setPenJoinStyle()

void QgsSimpleLineSymbolLayer::setPenJoinStyle ( Qt::PenJoinStyle  style)
inline

Sets the pen join style used to render the line (e.g.

miter, bevel, round, etc).

See also
penJoinStyle()

Definition at line 121 of file qgslinesymbollayer.h.

◆ setPenStyle()

void QgsSimpleLineSymbolLayer::setPenStyle ( Qt::PenStyle  style)
inline

Sets the pen style used to render the line (e.g.

solid, dashed, etc).

See also
penStyle()

Definition at line 107 of file qgslinesymbollayer.h.

◆ setTrimDistanceEnd()

void QgsSimpleLineSymbolLayer::setTrimDistanceEnd ( double  distance)
inline

Sets the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end.

Trim units can be set by calling setTrimDistanceEndUnit().

See also
trimDistanceEnd()
setTrimDistanceStart()
setTrimDistanceEndUnit()
setTrimDistanceEndMapUnitScale()
Since
QGIS 3.20

Definition at line 383 of file qgslinesymbollayer.h.

◆ setTrimDistanceEndMapUnitScale()

void QgsSimpleLineSymbolLayer::setTrimDistanceEndMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the trim distance for the end of the line.

See also
trimDistanceEndMapUnitScale()
setTrimDistanceStartMapUnitScale()
setTrimDistanceEnd()
setTrimDistanceEndUnit()
Since
QGIS 3.20

Definition at line 431 of file qgslinesymbollayer.h.

◆ setTrimDistanceEndUnit()

void QgsSimpleLineSymbolLayer::setTrimDistanceEndUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the trim distance for the end of the line.

See also
trimDistanceEndUnit()
setTrimDistanceStartUnit()
setTrimDistanceEnd()
setTrimDistanceEndMapUnitScale()
Since
QGIS 3.20

Definition at line 395 of file qgslinesymbollayer.h.

◆ setTrimDistanceStart()

void QgsSimpleLineSymbolLayer::setTrimDistanceStart ( double  distance)
inline

Sets the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start.

Trim units can be set by calling setTrimDistanceStartUnit().

See also
trimDistanceStart()
setTrimDistanceEnd()
setTrimDistanceStartUnit()
setTrimDistanceStartMapUnitScale()
Since
QGIS 3.20

Definition at line 305 of file qgslinesymbollayer.h.

◆ setTrimDistanceStartMapUnitScale()

void QgsSimpleLineSymbolLayer::setTrimDistanceStartMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the trim distance for the start of the line.

See also
trimDistanceStartMapUnitScale()
setTrimDistanceEndMapUnitScale()
setTrimDistanceStart()
setTrimDistanceStartUnit()
Since
QGIS 3.20

Definition at line 353 of file qgslinesymbollayer.h.

◆ setTrimDistanceStartUnit()

void QgsSimpleLineSymbolLayer::setTrimDistanceStartUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the trim distance for the start of the line.

See also
trimDistanceStartUnit()
setTrimDistanceEndUnit()
setTrimDistanceStart()
setTrimDistanceStartMapUnitScale()
Since
QGIS 3.20

Definition at line 317 of file qgslinesymbollayer.h.

◆ setTweakDashPatternOnCorners()

void QgsSimpleLineSymbolLayer::setTweakDashPatternOnCorners ( bool  enabled)

Sets whether dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner.

Note
This setting is only applied if alignDashPattern() is true.
See also
tweakDashPatternOnCorners()
setAlignDashPattern()
Since
QGIS 3.16

Definition at line 1131 of file qgslinesymbollayer.cpp.

◆ setUseCustomDashPattern()

void QgsSimpleLineSymbolLayer::setUseCustomDashPattern ( bool  b)
inline

Sets whether the line uses a custom dash pattern.

See also
useCustomDashPattern()
setCustomDashPatternUnit()
setCustomDashVector()

Definition at line 151 of file qgslinesymbollayer.h.

◆ startRender()

void QgsSimpleLineSymbolLayer::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 232 of file qgslinesymbollayer.cpp.

◆ stopRender()

void QgsSimpleLineSymbolLayer::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 278 of file qgslinesymbollayer.cpp.

◆ toSld()

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

Saves the symbol layer as SLD.

Reimplemented from QgsSymbolLayer.

Definition at line 570 of file qgslinesymbollayer.cpp.

◆ trimDistanceEnd()

double QgsSimpleLineSymbolLayer::trimDistanceEnd ( ) const
inline

Returns the trim distance for the end of the line, which dictates a length from the end of the line at which the actual rendering should end.

Trim units can be retrieved by calling trimDistanceEndUnit().

See also
setTrimDistanceEnd()
trimDistanceStart()
trimDistanceEndUnit()
trimDistanceEndMapUnitScale()
Since
QGIS 3.20

Definition at line 368 of file qgslinesymbollayer.h.

◆ trimDistanceEndMapUnitScale()

const QgsMapUnitScale& QgsSimpleLineSymbolLayer::trimDistanceEndMapUnitScale ( ) const
inline

Returns the map unit scale for the trim distance for the end of the line.

See also
setTrimDistanceEndMapUnitScale()
trimDistanceStartMapUnitScale()
trimDistanceEnd()
trimDistanceEndUnit()
Since
QGIS 3.20

Definition at line 419 of file qgslinesymbollayer.h.

◆ trimDistanceEndUnit()

QgsUnitTypes::RenderUnit QgsSimpleLineSymbolLayer::trimDistanceEndUnit ( ) const
inline

Returns the unit for the trim distance for the end of the line.

See also
setTrimDistanceEndUnit()
trimDistanceStartUnit()
trimDistanceEnd()
trimDistanceEndMapUnitScale()
Since
QGIS 3.20

Definition at line 407 of file qgslinesymbollayer.h.

◆ trimDistanceStart()

double QgsSimpleLineSymbolLayer::trimDistanceStart ( ) const
inline

Returns the trim distance for the start of the line, which dictates a length from the start of the line at which the actual rendering should start.

Trim units can be retrieved by calling trimDistanceStartUnit().

See also
setTrimDistanceStart()
trimDistanceEnd()
trimDistanceStartUnit()
trimDistanceStartMapUnitScale()
Since
QGIS 3.20

Definition at line 290 of file qgslinesymbollayer.h.

◆ trimDistanceStartMapUnitScale()

const QgsMapUnitScale& QgsSimpleLineSymbolLayer::trimDistanceStartMapUnitScale ( ) const
inline

Returns the map unit scale for the trim distance for the start of the line.

See also
setTrimDistanceStartMapUnitScale()
trimDistanceEndMapUnitScale()
trimDistanceStart()
trimDistanceStartUnit()
Since
QGIS 3.20

Definition at line 341 of file qgslinesymbollayer.h.

◆ trimDistanceStartUnit()

QgsUnitTypes::RenderUnit QgsSimpleLineSymbolLayer::trimDistanceStartUnit ( ) const
inline

Returns the unit for the trim distance for the start of the line.

See also
setTrimDistanceStartUnit()
trimDistanceEndUnit()
trimDistanceStart()
trimDistanceStartMapUnitScale()
Since
QGIS 3.20

Definition at line 329 of file qgslinesymbollayer.h.

◆ tweakDashPatternOnCorners()

bool QgsSimpleLineSymbolLayer::tweakDashPatternOnCorners ( ) const

Returns true if dash patterns tweaks should be applied on sharp corners, to ensure that a double-length dash is drawn running into and out of the corner.

Note
This setting is only applied if alignDashPattern() is true.
See also
setTweakDashPatternOnCorners()
alignDashPattern()
Since
QGIS 3.16

Definition at line 1126 of file qgslinesymbollayer.cpp.

◆ useCustomDashPattern()

bool QgsSimpleLineSymbolLayer::useCustomDashPattern ( ) const
inline

Returns true if the line uses a custom dash pattern.

See also
setUseCustomDashPattern()
customDashPatternUnit()
customDashVector()

Definition at line 143 of file qgslinesymbollayer.h.

◆ usesMapUnits()

bool QgsSimpleLineSymbolLayer::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 72 of file qgslinesymbollayer.cpp.


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