QGIS API Documentation 3.41.0-Master (af5edcb665c)
|
A line symbol layer type which fills a stroked line with a QgsFillSymbol. More...
#include <qgslinesymbollayer.h>
Public Member Functions | |
QgsFilledLineSymbolLayer (double width=DEFAULT_SIMPLELINE_WIDTH, QgsFillSymbol *fillSymbol=nullptr) | |
Constructor for QgsFilledLineSymbolLayer. | |
~QgsFilledLineSymbolLayer () override | |
QgsFilledLineSymbolLayer * | clone () 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. | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. | |
QString | layerType () const override |
Returns a string that represents this layer type. | |
QgsMapUnitScale | mapUnitScale () const override |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. | |
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. | |
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 | setColor (const QColor &c) override |
Sets the "representative" color for the symbol layer. | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (Qgis::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. | |
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. | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. | |
Public Member Functions inherited from QgsLineSymbolLayer | |
QgsLineSymbolLayer (const QgsLineSymbolLayer &other)=delete | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets line width. | |
QgsMapUnitScale | mapUnitScale () const override |
double | offset () const |
Returns the line's offset. | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the line's offset. | |
Qgis::RenderUnit | offsetUnit () const |
Returns the units for the line's offset. | |
QgsLineSymbolLayer & | operator= (const QgsLineSymbolLayer &other)=delete |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. | |
virtual void | renderPolygonStroke (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) |
Renders the line symbol layer along the outline of polygon, using the given render context. | |
RenderRingFilter | ringFilter () const |
Returns the line symbol layer's ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon's rings. | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (double offset) |
Sets the line's offset. | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the line's offset. | |
void | setOffsetUnit (Qgis::RenderUnit unit) |
Sets the unit for the line's offset. | |
void | setOutputUnit (Qgis::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. | |
void | setRingFilter (QgsLineSymbolLayer::RenderRingFilter filter) |
Sets the line symbol layer's ring filter, which controls which rings are rendered when the line symbol is being used to draw a polygon's rings. | |
virtual void | setWidth (double width) |
Sets the width of the line symbol layer. | |
void | setWidthMapUnitScale (const QgsMapUnitScale &scale) |
void | setWidthUnit (Qgis::RenderUnit unit) |
Sets the units for the line's width. | |
virtual double | width () const |
Returns the estimated width for the line symbol layer. | |
virtual double | width (const QgsRenderContext &context) const |
Returns the line symbol layer width, in painter units. | |
const QgsMapUnitScale & | widthMapUnitScale () const |
Qgis::RenderUnit | widthUnit () const |
Returns the units for the line's width. | |
Public Member Functions inherited from QgsSymbolLayer | |
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. | |
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 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. | |
QString | id () const |
Returns symbol layer identifier This id is unique in the whole project. | |
bool | installMasks (QgsRenderContext &context, bool recursive, const QRectF &rect=QRectF()) |
When rendering, install masks on context painter. | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. | |
bool | isLocked () const |
Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. | |
virtual QList< QgsSymbolLayerReference > | masks () const |
Returns masks defined by this symbol layer. | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. | |
virtual void | prepareMasks (const QgsSymbolRenderContext &context) |
Prepares all mask internal objects according to what is defined in context This should be called prior to calling startRender() method. | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. | |
virtual void | setFillColor (const QColor &color) |
Sets the fill color for the symbol layer. | |
void | setId (const QString &id) |
Set symbol layer identifier This id has to be unique in the whole project. | |
void | setLocked (bool locked) |
Sets whether the layer's colors are locked. | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. | |
void | setRenderingPass (int renderingPass) |
Specifies the rendering pass in which this symbol layer should be rendered. | |
virtual void | setStrokeColor (const QColor &color) |
Sets the stroke color for the symbol layer. | |
void | setUserFlags (Qgis::SymbolLayerUserFlags flags) |
Sets user-controlled flags which control the symbol layer's behavior. | |
virtual void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called before the layer will be rendered for a particular feature. | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. | |
virtual QColor | strokeColor () const |
Returns the stroke color for the symbol layer. | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const |
Saves the symbol layer as SLD. | |
Qgis::SymbolType | type () const |
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 QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates a new QgsFilledLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsFilledLineSymbolLayer::properties() ). | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. | |
Additional Inherited Members | |
Public Types inherited from QgsLineSymbolLayer | |
enum | RenderRingFilter { AllRings , ExteriorRingOnly , InteriorRingsOnly } |
Options for filtering rings when the line symbol layer is being used to render a polygon's rings. More... | |
Public Types inherited from QgsSymbolLayer | |
enum class | Property : int { Size = 0 , Angle , Name , FillColor , StrokeColor , StrokeWidth , StrokeStyle , Offset , Character , Width , Height , PreserveAspectRatio , FillStyle , JoinStyle , SecondaryColor , LineAngle , LineDistance , GradientType , CoordinateMode , GradientSpread , GradientReference1X , GradientReference1Y , GradientReference2X , GradientReference2Y , GradientReference1IsCentroid , GradientReference2IsCentroid , BlurRadius , ShapeburstUseWholeShape , ShapeburstMaxDistance , ShapeburstIgnoreRings , File , DistanceX , DistanceY , DisplacementX , DisplacementY , Opacity , CustomDash , CapStyle , Placement , Interval , OffsetAlongLine , AverageAngleLength , HorizontalAnchor , VerticalAnchor , LayerEnabled , ArrowWidth , ArrowStartWidth , ArrowHeadLength , ArrowHeadThickness , ArrowHeadType , ArrowType , OffsetX , OffsetY , PointCount , RandomSeed , ClipPoints , DensityArea , FontFamily , FontStyle , DashPatternOffset , TrimStart , TrimEnd , LineStartWidthValue , LineEndWidthValue , LineStartColorValue , LineEndColorValue , MarkerClipping , RandomOffsetX , RandomOffsetY , LineClipping , SkipMultiples , ShowMarker } |
Data definable properties. More... | |
Protected Member Functions inherited from QgsLineSymbolLayer | |
QgsLineSymbolLayer (bool locked=false) | |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (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 inherited from QgsLineSymbolLayer | |
double | mOffset = 0 |
QgsMapUnitScale | mOffsetMapUnitScale |
Qgis::RenderUnit | mOffsetUnit = Qgis::RenderUnit::Millimeters |
RenderRingFilter | mRingFilter = AllRings |
double | mWidth = 0 |
QgsMapUnitScale | mWidthMapUnitScale |
Qgis::RenderUnit | mWidthUnit = Qgis::RenderUnit::Millimeters |
Protected Attributes inherited from QgsSymbolLayer | |
QPainterPath | mClipPath |
QColor | mColor |
QgsPropertyCollection | mDataDefinedProperties |
bool | mEnabled = true |
True if layer is enabled and should be drawn. | |
QgsFields | mFields |
QString | mId |
bool | mLocked = false |
std::unique_ptr< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
Qgis::SymbolType | mType |
Qgis::SymbolLayerUserFlags | mUserFlags |
User controlled flags. | |
Static Protected Attributes inherited from QgsSymbolLayer | |
static const bool | SELECT_FILL_BORDER = false |
Whether fill styles for selected features also highlight symbol stroke. | |
static const bool | SELECT_FILL_STYLE = false |
Whether fill styles for selected features uses symbol layer style. | |
static const bool | SELECTION_IS_OPAQUE = true |
Whether styles for selected features ignore symbol alpha. | |
A line symbol layer type which fills a stroked line with a QgsFillSymbol.
Definition at line 1379 of file qgslinesymbollayer.h.
QgsFilledLineSymbolLayer::QgsFilledLineSymbolLayer | ( | double | width = DEFAULT_SIMPLELINE_WIDTH , |
QgsFillSymbol * | fillSymbol = nullptr |
||
) |
Constructor for QgsFilledLineSymbolLayer.
If a fillSymbol is specified, it will be transferred to the symbol layer and used to fill the inside of the stroked line. If no fillSymbol is specified then a default symbol will be used.
Definition at line 3823 of file qgslinesymbollayer.cpp.
|
overridedefault |
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 4021 of file qgslinesymbollayer.cpp.
|
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).
Reimplemented from QgsSymbolLayer.
Definition at line 4082 of file qgslinesymbollayer.cpp.
|
static |
Creates a new QgsFilledLineSymbolLayer, using the settings serialized in the properties map (corresponding to the output from QgsFilledLineSymbolLayer::properties() ).
Definition at line 3832 of file qgslinesymbollayer.cpp.
|
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 4049 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsSymbolLayer.
Definition at line 4066 of file qgslinesymbollayer.cpp.
|
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 3885 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 4101 of file qgslinesymbollayer.cpp.
|
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.
Reimplemented from QgsSymbolLayer.
Definition at line 4117 of file qgslinesymbollayer.cpp.
|
inline |
Returns the pen cap style used to render the line (e.g.
flat, square, round, etc).
Definition at line 1438 of file qgslinesymbollayer.h.
|
inline |
Returns the pen join style used to render the line (e.g.
miter, bevel, round, etc).
Definition at line 1424 of file qgslinesymbollayer.h.
|
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 4002 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Renders the line symbol layer along the line joining points, using the given render context.
Implements QgsLineSymbolLayer.
Definition at line 3907 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Sets the "representative" color for the symbol layer.
Depending on the symbol layer type, this will have different meaning. For instance, a line symbol layer will generally set the stroke color of the layer, while a fill symbol layer will set the "fill" color instead of stroke.
Reimplemented from QgsSymbolLayer.
Definition at line 4075 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 4094 of file qgslinesymbollayer.cpp.
|
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.
unit | output units |
Reimplemented from QgsSymbolLayer.
Definition at line 4110 of file qgslinesymbollayer.cpp.
|
inline |
Sets the pen cap style used to render the line (e.g.
flat, square, round, etc).
Definition at line 1445 of file qgslinesymbollayer.h.
|
inline |
Sets the pen join style used to render the line (e.g.
miter, bevel, round, etc).
Definition at line 1431 of file qgslinesymbollayer.h.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 4035 of file qgslinesymbollayer.cpp.
|
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.
Implements QgsSymbolLayer.
Definition at line 3890 of file qgslinesymbollayer.cpp.
|
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.
Implements QgsSymbolLayer.
Definition at line 3899 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 4030 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns the set of attributes referenced by the layer.
This includes attributes required by any data defined properties associated with the layer.
Reimplemented from QgsSymbolLayer.
Definition at line 4058 of file qgslinesymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 4087 of file qgslinesymbollayer.cpp.