QGIS API Documentation  3.8.0-Zanzibar (11aff65)
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsLineSymbolLayer Class Referenceabstract

#include <qgssymbollayer.h>

Inheritance diagram for QgsLineSymbolLayer:
Inheritance graph
[legend]

Public Types

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

Public Member Functions

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...
 
QgsUnitTypes::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer. More...
 
virtual void renderPolygonStroke (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context)
 Renders the line symbol layer along the outline of polygon, using the given render context. More...
 
virtual void renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context)=0
 Renders the line symbol layer along the line joining points, using the given render context. 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
virtual ~QgsSymbolLayer ()
 
virtual QgsSymbolLayerclone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance. More...
 
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...
 
virtual QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color. More...
 
virtual QVector< qreal > dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const
 Gets dash pattern. More...
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset. More...
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style. More...
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn. More...
 
virtual 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. More...
 
virtual QColor fillColor () const
 Gets fill color. 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
 
virtual QString layerType () const =0
 Returns a string that represents this layer type. More...
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
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...
 
virtual QgsStringMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. 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)
 
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 startRender (QgsSymbolRenderContext &context)=0
 
virtual void stopRender (QgsSymbolRenderContext &context)=0
 
virtual QColor strokeColor () const
 Gets stroke color. More...
 
virtual QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present. More...
 
virtual void toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const
 
QgsSymbol::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...
 

Protected Member Functions

 QgsLineSymbolLayer (bool locked=false)
 
- Protected Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false)
 
void copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
 Copies all data defined properties of this layer to another symbol layer. More...
 
void copyPaintEffect (QgsSymbolLayer *destLayer) const
 Copies paint effect of this layer to another symbol layer. More...
 
void restoreOldDataDefinedProperties (const QgsStringMap &stringMap)
 Restores older data defined properties from string map. More...
 

Protected Attributes

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 if layer is enabled and should be drawn. More...
 
QgsFields mFields
 
bool mLocked
 
QgsPaintEffectmPaintEffect = nullptr
 
int mRenderingPass = 0
 
QgsSymbol::SymbolType mType
 

Additional Inherited Members

- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions. More...
 
- 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

Definition at line 792 of file qgssymbollayer.h.

Member Enumeration Documentation

◆ RenderRingFilter

Options for filtering rings when the line symbol layer is being used to render a polygon's rings.

Enumerator
AllRings 

Render both exterior and interior rings.

ExteriorRingOnly 

Render the exterior ring only.

InteriorRingsOnly 

Render the interior rings only.

Definition at line 797 of file qgssymbollayer.h.

Constructor & Destructor Documentation

◆ QgsLineSymbolLayer()

QgsLineSymbolLayer::QgsLineSymbolLayer ( bool  locked = false)
protected

Definition at line 404 of file qgssymbollayer.cpp.

Member Function Documentation

◆ drawPreviewIcon()

void QgsLineSymbolLayer::drawPreviewIcon ( QgsSymbolRenderContext context,
QSize  size 
)
overridevirtual

Implements QgsSymbolLayer.

Definition at line 619 of file qgssymbollayer.cpp.

◆ dxfWidth()

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

Gets line width.

Reimplemented from QgsSymbolLayer.

Definition at line 674 of file qgssymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsLineSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 613 of file qgssymbollayer.cpp.

◆ offset()

double QgsLineSymbolLayer::offset ( ) const
inline

Returns the line's offset.

Offset units can be retrieved by calling offsetUnit().

See also
setOffset()
offsetUnit()
offsetMapUnitScale()

Definition at line 874 of file qgssymbollayer.h.

◆ offsetMapUnitScale()

const QgsMapUnitScale& QgsLineSymbolLayer::offsetMapUnitScale ( ) const
inline

Returns the map unit scale for the line's offset.

See also
setOffsetMapUnitScale()
offset()
offsetUnit()

Definition at line 917 of file qgssymbollayer.h.

◆ offsetUnit()

QgsUnitTypes::RenderUnit QgsLineSymbolLayer::offsetUnit ( ) const
inline

Returns the units for the line's offset.

See also
setOffsetUnit()
offset()
offsetMapUnitScale()

Definition at line 901 of file qgssymbollayer.h.

◆ outputUnit()

QgsUnitTypes::RenderUnit QgsLineSymbolLayer::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 603 of file qgssymbollayer.cpp.

◆ renderPolygonStroke()

void QgsLineSymbolLayer::renderPolygonStroke ( const QPolygonF &  points,
QList< QPolygonF > *  rings,
QgsSymbolRenderContext context 
)
virtual

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 in QgsTemplatedLineSymbolLayerBase, and QgsSimpleLineSymbolLayer.

Definition at line 640 of file qgssymbollayer.cpp.

◆ renderPolyline()

virtual void QgsLineSymbolLayer::renderPolyline ( const QPolygonF &  points,
QgsSymbolRenderContext context 
)
pure virtual

Renders the line symbol layer along the line joining points, using the given render context.

See also
renderPolygonStroke()

Implemented in QgsTemplatedLineSymbolLayerBase, QgsArrowSymbolLayer, and QgsSimpleLineSymbolLayer.

◆ ringFilter()

QgsLineSymbolLayer::RenderRingFilter QgsLineSymbolLayer::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.

This setting has no effect when the line symbol is not being rendered for a polygon.

See also
setRingFilter()
Since
QGIS 3.6

Definition at line 409 of file qgssymbollayer.cpp.

◆ setMapUnitScale()

void QgsLineSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsSymbolLayer.

Definition at line 608 of file qgssymbollayer.cpp.

◆ setOffset()

void QgsLineSymbolLayer::setOffset ( double  offset)
inline

Sets the line's offset.

Offset units are set via setOffsetUnit().

See also
offset()
setOffsetUnit()
setOffsetMapUnitScale()

Definition at line 885 of file qgssymbollayer.h.

◆ setOffsetMapUnitScale()

void QgsLineSymbolLayer::setOffsetMapUnitScale ( const QgsMapUnitScale scale)
inline

Sets the map unit scale for the line's offset.

See also
offsetMapUnitScale()
setOffset()
setOffsetUnit()

Definition at line 909 of file qgssymbollayer.h.

◆ setOffsetUnit()

void QgsLineSymbolLayer::setOffsetUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the unit for the line's offset.

See also
offsetUnit()
setOffset()
setOffsetMapUnitScale()

Definition at line 893 of file qgssymbollayer.h.

◆ setOutputUnit()

void QgsLineSymbolLayer::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 598 of file qgssymbollayer.cpp.

◆ setRingFilter()

void QgsLineSymbolLayer::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.

This setting has no effect when the line symbol is not being rendered for a polygon.

See also
ringFilter()
Since
QGIS 3.6

Definition at line 414 of file qgssymbollayer.cpp.

◆ setWidth()

virtual void QgsLineSymbolLayer::setWidth ( double  width)
inlinevirtual

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 in QgsHashedLineSymbolLayer, and QgsMarkerLineSymbolLayer.

Definition at line 840 of file qgssymbollayer.h.

◆ setWidthMapUnitScale()

void QgsLineSymbolLayer::setWidthMapUnitScale ( const QgsMapUnitScale scale)
inline

Definition at line 935 of file qgssymbollayer.h.

◆ setWidthUnit()

void QgsLineSymbolLayer::setWidthUnit ( QgsUnitTypes::RenderUnit  unit)
inline

Sets the units for the line's width.

Parameters
unitwidth units
See also
widthUnit()

Definition at line 927 of file qgssymbollayer.h.

◆ width() [1/2]

virtual double QgsLineSymbolLayer::width ( ) const
inlinevirtual

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 in QgsHashedLineSymbolLayer, and QgsMarkerLineSymbolLayer.

Definition at line 851 of file qgssymbollayer.h.

◆ width() [2/2]

double QgsLineSymbolLayer::width ( const QgsRenderContext context) const
virtual

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 in QgsHashedLineSymbolLayer, and QgsMarkerLineSymbolLayer.

Definition at line 669 of file qgssymbollayer.cpp.

◆ widthMapUnitScale()

const QgsMapUnitScale& QgsLineSymbolLayer::widthMapUnitScale ( ) const
inline

Definition at line 936 of file qgssymbollayer.h.

◆ widthUnit()

QgsUnitTypes::RenderUnit QgsLineSymbolLayer::widthUnit ( ) const
inline

Returns the units for the line's width.

See also
setWidthUnit()

Definition at line 933 of file qgssymbollayer.h.

Member Data Documentation

◆ mOffset

double QgsLineSymbolLayer::mOffset = 0
protected

Definition at line 968 of file qgssymbollayer.h.

◆ mOffsetMapUnitScale

QgsMapUnitScale QgsLineSymbolLayer::mOffsetMapUnitScale
protected

Definition at line 970 of file qgssymbollayer.h.

◆ mOffsetUnit

QgsUnitTypes::RenderUnit QgsLineSymbolLayer::mOffsetUnit = QgsUnitTypes::RenderMillimeters
protected

Definition at line 969 of file qgssymbollayer.h.

◆ mRingFilter

RenderRingFilter QgsLineSymbolLayer::mRingFilter = AllRings
protected

Definition at line 972 of file qgssymbollayer.h.

◆ mWidth

double QgsLineSymbolLayer::mWidth = 0
protected

Definition at line 965 of file qgssymbollayer.h.

◆ mWidthMapUnitScale

QgsMapUnitScale QgsLineSymbolLayer::mWidthMapUnitScale
protected

Definition at line 967 of file qgssymbollayer.h.

◆ mWidthUnit

QgsUnitTypes::RenderUnit QgsLineSymbolLayer::mWidthUnit = QgsUnitTypes::RenderMillimeters
protected

Definition at line 966 of file qgssymbollayer.h.


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