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

Line symbol layer type which draws line sections using a raster image file. More...

#include <qgslinesymbollayer.h>

Inheritance diagram for QgsRasterLineSymbolLayer:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterLineSymbolLayer (const QString &path=QString())
 Constructor for QgsRasterLineSymbolLayer, with the specified raster image path.
 
virtual ~QgsRasterLineSymbolLayer ()
 
QgsRasterLineSymbolLayerclone () const override
 Shall be reimplemented by subclasses to create a deep copy of the instance.
 
QColor color () const override
 Returns the "representative" color of the symbol layer.
 
double estimateMaxBleed (const QgsRenderContext &context) const override
 Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context.
 
QString layerType () const override
 Returns a string that represents this layer type.
 
QgsMapUnitScale mapUnitScale () const override
 
double opacity () const
 Returns the line opacity.
 
Qgis::RenderUnit outputUnit () const override
 Returns the units to use for sizes and widths within the symbol layer.
 
QString path () const
 Returns the raster image path.
 
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.
 
void setMapUnitScale (const QgsMapUnitScale &scale) override
 
void setOpacity (double opacity)
 Set the line opacity.
 
void setOutputUnit (Qgis::RenderUnit unit) override
 Sets the units to use for sizes and widths within the symbol layer.
 
void setPath (const QString &path)
 Set the raster image path.
 
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.
 
bool usesMapUnits () const override
 Returns true if the symbol layer has any components which use map unit based sizes.
 
- Public Member Functions inherited from QgsAbstractBrushedLineSymbolLayer
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
 QgsLineSymbolLayer cannot be copied.
 
void drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override
 
double dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override
 Gets line width.
 
double offset () const
 Returns the line's offset.
 
const QgsMapUnitScaleoffsetMapUnitScale () const
 Returns the map unit scale for the line's offset.
 
Qgis::RenderUnit offsetUnit () const
 Returns the units for the line's offset.
 
QgsLineSymbolLayeroperator= (const QgsLineSymbolLayer &other)=delete
 QgsLineSymbolLayer cannot be copied.
 
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 setOffset (double offset)
 Sets the line's offset.
 
void setOffsetMapUnitScale (const QgsMapUnitScale &scale)
 Sets the map unit scale for the line's offset.
 
void setOffsetUnit (Qgis::RenderUnit unit)
 Sets the unit for the line's offset.
 
void setRingFilter (QgsLineSymbolLayer::RenderRingFilter filter)
 Sets the line symbol layer's ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon's rings.
 
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 QgsMapUnitScalewidthMapUnitScale () const
 
Qgis::RenderUnit widthUnit () const
 Returns the units for the line's width.
 
- Public Member Functions inherited from QgsSymbolLayer
 QgsSymbolLayer (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied.
 
virtual ~QgsSymbolLayer ()
 
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.
 
QgsPropertyCollectiondataDefinedProperties ()
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
const QgsPropertyCollectiondataDefinedProperties () const
 Returns a reference to the symbol layer's property collection, used for data defined overrides.
 
virtual double dxfAngle (QgsSymbolRenderContext &context) const
 Gets angle.
 
virtual QColor dxfBrushColor (QgsSymbolRenderContext &context) const
 Gets brush/fill color.
 
virtual Qt::BrushStyle dxfBrushStyle () const
 Gets brush/fill style.
 
virtual QColor dxfColor (QgsSymbolRenderContext &context) const
 Gets color.
 
virtual QVector< qreal > dxfCustomDashPattern (Qgis::RenderUnit &unit) const
 Gets dash pattern.
 
virtual double dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets offset.
 
virtual Qt::PenStyle dxfPenStyle () const
 Gets pen style.
 
virtual double dxfSize (const QgsDxfExport &e, QgsSymbolRenderContext &context) const
 Gets marker size.
 
bool enabled () const
 Returns true if symbol layer is enabled and will be drawn.
 
virtual QColor fillColor () const
 Returns the fill color for the symbol layer.
 
virtual Qgis::SymbolLayerFlags flags () const
 Returns flags which control the symbol layer's behavior.
 
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.
 
virtual bool isCompatibleWithSymbol (QgsSymbol *symbol) const
 Returns if the layer can be used below the specified symbol.
 
bool isLocked () const
 Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes.
 
virtual QList< QgsSymbolLayerReferencemasks () const
 Returns masks defined by this symbol layer.
 
virtual QString ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const
 
QgsSymbolLayeroperator= (const QgsSymbolLayer &other)=delete
 QgsSymbolLayer cannot be copied.
 
QgsPaintEffectpaintEffect () const
 Returns the current paint effect for the layer.
 
virtual void prepareExpressions (const QgsSymbolRenderContext &context)
 Prepares all data defined property expressions for evaluation.
 
virtual void prepareMasks (const QgsSymbolRenderContext &context)
 Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method.
 
int renderingPass () const
 Specifies the rendering pass in which this symbol layer should be rendered.
 
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 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 QgsSymbolsubSymbol ()
 Returns the symbol's sub symbol, if present.
 
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 writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const
 write as DXF
 

Static Public Member Functions

static QgsSymbolLayercreate (const QVariantMap &properties=QVariantMap())
 Creates a new QgsRasterLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsRasterLineSymbolLayer::properties() ).
 
static void resolvePaths (QVariantMap &properties, const QgsPathResolver &pathResolver, bool saving)
 Turns relative paths in properties map to absolute when reading and vice versa when writing.
 
- Static Public Member Functions inherited from QgsSymbolLayer
static const QgsPropertiesDefinitionpropertyDefinitions ()
 Returns the symbol layer property definitions.
 

Protected Attributes

QImage mLineImage
 
double mOpacity = 1.0
 
QString mPath
 
- Protected Attributes inherited from QgsAbstractBrushedLineSymbolLayer
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< QgsPaintEffectmPaintEffect
 
int mRenderingPass = 0
 
Qgis::SymbolType mType
 
Qgis::SymbolLayerUserFlags mUserFlags
 User controlled flags.
 

Additional Inherited Members

- Public Types inherited from QgsLineSymbolLayer
enum  RenderRingFilter { AllRings , ExteriorRingOnly , InteriorRingsOnly }
 Options for filtering rings when the line symbol layer is being used to render a polygon's rings. More...
 
- Public Types inherited from QgsSymbolLayer
enum class  Property : int {
  Size = 0 , Angle , Name , FillColor ,
  StrokeColor , StrokeWidth , StrokeStyle , Offset ,
  Character , Width , Height , PreserveAspectRatio ,
  FillStyle , JoinStyle , SecondaryColor , LineAngle ,
  LineDistance , GradientType , CoordinateMode , GradientSpread ,
  GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y ,
  GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape ,
  ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX ,
  DistanceY , DisplacementX , DisplacementY , Opacity ,
  CustomDash , CapStyle , Placement , Interval ,
  OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor ,
  LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength ,
  ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX ,
  OffsetY , PointCount , RandomSeed , ClipPoints ,
  DensityArea , FontFamily , FontStyle , DashPatternOffset ,
  TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue ,
  LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX ,
  RandomOffsetY , LineClipping
}
 Data definable properties. More...
 
- Protected Member Functions inherited from QgsAbstractBrushedLineSymbolLayer
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 (Qgis::SymbolType type, bool locked=false)
 Constructor for QgsSymbolLayer.
 
void copyDataDefinedProperties (QgsSymbolLayer *destLayer) const
 Copies all data defined properties of this layer to another symbol layer.
 
void copyPaintEffect (QgsSymbolLayer *destLayer) const
 Copies paint effect of this layer to another symbol layer.
 
void installMasks (QgsRenderContext &context, bool recursive)
 When rendering, install masks on context painter if recursive is true masks are installed recursively for all children symbol layers.
 
void removeMasks (QgsRenderContext &context, bool recursive)
 When rendering, remove previously installed masks from context painter if recursive is true masks are removed recursively for all children symbol layers.
 
void restoreOldDataDefinedProperties (const QVariantMap &stringMap)
 Restores older data defined properties from string map.
 
bool shouldRenderUsingSelectionColor (const QgsSymbolRenderContext &context) const
 Returns true if the symbol layer should be rendered using the selection color from the render context.
 
- Static Protected Attributes inherited from QgsSymbolLayer
static const bool SELECT_FILL_BORDER = false
 Whether fill styles for selected features also highlight symbol stroke.
 
static const bool SELECT_FILL_STYLE = false
 Whether fill styles for selected features uses symbol layer style.
 
static const bool SELECTION_IS_OPAQUE = true
 Whether styles for selected features ignore symbol alpha.
 

Detailed Description

Line symbol layer type which draws line sections using a raster image file.

Since
QGIS 3.24

Definition at line 1202 of file qgslinesymbollayer.h.

Constructor & Destructor Documentation

◆ QgsRasterLineSymbolLayer()

QgsRasterLineSymbolLayer::QgsRasterLineSymbolLayer ( const QString &  path = QString())

Constructor for QgsRasterLineSymbolLayer, with the specified raster image path.

Definition at line 3321 of file qgslinesymbollayer.cpp.

◆ ~QgsRasterLineSymbolLayer()

QgsRasterLineSymbolLayer::~QgsRasterLineSymbolLayer ( )
virtualdefault

Member Function Documentation

◆ clone()

QgsRasterLineSymbolLayer * QgsRasterLineSymbolLayer::clone ( ) const
overridevirtual

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

Implements QgsSymbolLayer.

Definition at line 3396 of file qgslinesymbollayer.cpp.

◆ color()

QColor QgsRasterLineSymbolLayer::color ( ) const
overridevirtual

Returns the "representative" color of the symbol layer.

Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally return the stroke color of the layer, while a fill symbol layer will return the "fill" color instead of stroke.

Some symbol layer types will return an invalid QColor if they have no representative color associated (e.g. raster image based symbol layers).

See also
setColor()
strokeColor()
fillColor()

Reimplemented from QgsSymbolLayer.

Definition at line 3549 of file qgslinesymbollayer.cpp.

◆ create()

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

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

Definition at line 3328 of file qgslinesymbollayer.cpp.

◆ estimateMaxBleed()

double QgsRasterLineSymbolLayer::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 3544 of file qgslinesymbollayer.cpp.

◆ layerType()

QString QgsRasterLineSymbolLayer::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 3430 of file qgslinesymbollayer.cpp.

◆ mapUnitScale()

QgsMapUnitScale QgsRasterLineSymbolLayer::mapUnitScale ( ) const
overridevirtual

Reimplemented from QgsLineSymbolLayer.

Definition at line 3534 of file qgslinesymbollayer.cpp.

◆ opacity()

double QgsRasterLineSymbolLayer::opacity ( ) const
inline

Returns the line opacity.

Returns
opacity value between 0 (fully transparent) and 1 (fully opaque)
See also
setOpacity()

Definition at line 1242 of file qgslinesymbollayer.h.

◆ outputUnit()

Qgis::RenderUnit QgsRasterLineSymbolLayer::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 QgsLineSymbolLayer.

Definition at line 3512 of file qgslinesymbollayer.cpp.

◆ path()

QString QgsRasterLineSymbolLayer::path ( ) const
inline

Returns the raster image path.

See also
setPath()

Definition at line 1229 of file qgslinesymbollayer.h.

◆ properties()

QVariantMap QgsRasterLineSymbolLayer::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 3375 of file qgslinesymbollayer.cpp.

◆ renderPolyline()

void QgsRasterLineSymbolLayer::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 3453 of file qgslinesymbollayer.cpp.

◆ resolvePaths()

void QgsRasterLineSymbolLayer::resolvePaths ( QVariantMap &  properties,
const QgsPathResolver pathResolver,
bool  saving 
)
static

Turns relative paths in properties map to absolute when reading and vice versa when writing.

Used internally when reading/writing symbols.

Definition at line 3413 of file qgslinesymbollayer.cpp.

◆ setMapUnitScale()

void QgsRasterLineSymbolLayer::setMapUnitScale ( const QgsMapUnitScale scale)
overridevirtual

Reimplemented from QgsLineSymbolLayer.

Definition at line 3528 of file qgslinesymbollayer.cpp.

◆ setOpacity()

void QgsRasterLineSymbolLayer::setOpacity ( double  opacity)
inline

Set the line opacity.

Parameters
opacityopacity value between 0 (fully transparent) and 1 (fully opaque)
See also
opacity()

Definition at line 1249 of file qgslinesymbollayer.h.

◆ setOutputUnit()

void QgsRasterLineSymbolLayer::setOutputUnit ( Qgis::RenderUnit  unit)
overridevirtual

Sets the units to use for sizes and widths within the symbol layer.

Individual symbol layer subclasses will interpret this in different ways, e.g., a marker symbol layer may use it to specify the units for the marker size, while a line symbol layer may use it to specify the units for the line width.

Parameters
unitoutput units
See also
outputUnit()

Reimplemented from QgsLineSymbolLayer.

Definition at line 3505 of file qgslinesymbollayer.cpp.

◆ setPath()

void QgsRasterLineSymbolLayer::setPath ( const QString &  path)

Set the raster image path.

See also
path()

Definition at line 3425 of file qgslinesymbollayer.cpp.

◆ startRender()

void QgsRasterLineSymbolLayer::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 3435 of file qgslinesymbollayer.cpp.

◆ stopRender()

void QgsRasterLineSymbolLayer::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 3449 of file qgslinesymbollayer.cpp.

◆ usesMapUnits()

bool QgsRasterLineSymbolLayer::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 3522 of file qgslinesymbollayer.cpp.

Member Data Documentation

◆ mLineImage

QImage QgsRasterLineSymbolLayer::mLineImage
protected

Definition at line 1268 of file qgslinesymbollayer.h.

◆ mOpacity

double QgsRasterLineSymbolLayer::mOpacity = 1.0
protected

Definition at line 1267 of file qgslinesymbollayer.h.

◆ mPath

QString QgsRasterLineSymbolLayer::mPath
protected

Definition at line 1266 of file qgslinesymbollayer.h.


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