QGIS API Documentation 3.99.0-Master (2fe06baccd8)
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsAbstractBrushedLineSymbolLayer Class Reference
core library

Base class for line symbol layer types which draws line sections using a QBrush. More...

#include <qgslinesymbollayer.h>

Inheritance diagram for QgsAbstractBrushedLineSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

Qt::PenCapStyle penCapStyle () const
 Returns the pen cap style used to render the line (e.g.
Qt::PenJoinStyle penJoinStyle () const
 Returns the pen join style used to render the line (e.g.
void setPenCapStyle (Qt::PenCapStyle style)
 Sets the pen cap style used to render the line (e.g.
void setPenJoinStyle (Qt::PenJoinStyle style)
 Sets the pen join style used to render the line (e.g.
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.
virtual void renderPolyline (const QPolygonF &points, QgsSymbolRenderContext &context)=0
 Renders the line symbol layer along the line joining points, 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
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 QgsSymbolLayer * clone () const =0
 Shall be reimplemented by subclasses to create a deep copy of the instance.
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 Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior.
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 QString layerType () const =0
 Returns a string that represents this layer type.
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.
virtual QVariantMap properties () const =0
 Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer.
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered.
virtual bool rendersIdenticallyTo (const QgsSymbolLayer *other) const
 Returns true if this symbol layer will always render identically to an other symbol layer.
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.
virtual bool setSubSymbol (QgsSymbol *symbol)
 Sets layer's subsymbol. takes ownership of the passed symbol.
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 startRender (QgsSymbolRenderContext &context)=0
 Called before a set of rendering operations commences on the supplied render context.
virtual void stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context)
 Called after the layer has been rendered for a particular feature.
virtual void stopRender (QgsSymbolRenderContext &context)=0
 Called after a set of rendering operations has finished on the supplied render context.
virtual QColor strokeColor () const
 Returns the stroke color for the symbol layer.
virtual QgsSymbol * subSymbol ()
 Returns the symbol's sub symbol, if present.
virtual Q_DECL_DEPRECATED void toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const
 Saves the symbol layer as SLD.
virtual bool toSld (QDomDocument &doc, QDomElement &element, QgsSldExportContext &context) 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

Protected Member Functions

void renderPolylineUsingBrush (const QPolygonF &points, QgsSymbolRenderContext &context, const QBrush &brush, double patternThickness, double patternLength)
 Renders a polyline of points using the specified brush.
Protected Member Functions inherited from QgsLineSymbolLayer
 QgsLineSymbolLayer (bool locked=false)
Protected Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)
 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

Qt::PenCapStyle mPenCapStyle = Qt::PenCapStyle::RoundCap
Qt::PenJoinStyle mPenJoinStyle = Qt::PenJoinStyle::RoundJoin
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.

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 ,
  BlankSegments
}
 Data definable properties. More...
Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinition & propertyDefinitions ()
 Returns the symbol layer property definitions.
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

Base class for line symbol layer types which draws line sections using a QBrush.

Since
QGIS 3.24

Definition at line 1172 of file qgslinesymbollayer.h.

Member Function Documentation

◆ penCapStyle()

Qt::PenCapStyle QgsAbstractBrushedLineSymbolLayer::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 1195 of file qgslinesymbollayer.h.

◆ penJoinStyle()

Qt::PenJoinStyle QgsAbstractBrushedLineSymbolLayer::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 1181 of file qgslinesymbollayer.h.

◆ renderPolylineUsingBrush()

void QgsAbstractBrushedLineSymbolLayer::renderPolylineUsingBrush ( const QPolygonF & points,
QgsSymbolRenderContext & context,
const QBrush & brush,
double patternThickness,
double patternLength )
protected

Renders a polyline of points using the specified brush.

Definition at line 3156 of file qgslinesymbollayer.cpp.

◆ setPenCapStyle()

void QgsAbstractBrushedLineSymbolLayer::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 1202 of file qgslinesymbollayer.h.

◆ setPenJoinStyle()

void QgsAbstractBrushedLineSymbolLayer::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 1188 of file qgslinesymbollayer.h.

Member Data Documentation

◆ mPenCapStyle

Qt::PenCapStyle QgsAbstractBrushedLineSymbolLayer::mPenCapStyle = Qt::PenCapStyle::RoundCap
protected

Definition at line 1213 of file qgslinesymbollayer.h.

◆ mPenJoinStyle

Qt::PenJoinStyle QgsAbstractBrushedLineSymbolLayer::mPenJoinStyle = Qt::PenJoinStyle::RoundJoin
protected

Definition at line 1212 of file qgslinesymbollayer.h.

The documentation for this class was generated from the following files:
Generated on for QGIS API Documentation by doxygen 1.15.0