QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A symbol fill consisting of repeated parallel lines. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsLinePatternFillSymbolLayer () | |
~QgsLinePatternFillSymbolLayer () override | |
Qgis::LineClipMode | clipMode () const |
Returns the line clipping mode, which defines how lines are clipped at the edges of shapes. | |
QgsLinePatternFillSymbolLayer * | 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 | distance () const |
Returns the distance between lines in the fill pattern. | |
const QgsMapUnitScale & | distanceMapUnitScale () const |
Returns the map unit scale for the pattern's line distance. | |
Qgis::RenderUnit | distanceUnit () const |
Returns the units for the distance between lines in the fill pattern. | |
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. | |
double | lineAngle () const |
Returns the angle for the parallel lines used to fill the symbol. | |
double | lineWidth () const |
Returns the width of the line subsymbol used to render the parallel lines in the fill. | |
const QgsMapUnitScale & | lineWidthMapUnitScale () const |
Returns the map unit scale for the pattern's line width. | |
Qgis::RenderUnit | lineWidthUnit () const |
Returns the units for the line's width. | |
QgsMapUnitScale | mapUnitScale () const override |
double | offset () const |
Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position. | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the pattern's line offset. | |
Qgis::RenderUnit | offsetUnit () const |
Returns the units for the line pattern's offset. | |
QString | ogrFeatureStyleWidth (double widthScaleFactor) const |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. | |
QVariantMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. | |
void | renderPolygon (const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context. | |
void | setClipMode (Qgis::LineClipMode mode) |
Sets the line clipping mode, which defines how lines are clipped at the edges of shapes. | |
void | setColor (const QColor &c) override |
Sets the "representative" color for the symbol layer. | |
void | setDistance (double d) |
Sets the distance between lines in the fill pattern. | |
void | setDistanceMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's line distance. | |
void | setDistanceUnit (Qgis::RenderUnit unit) |
Sets the unit for the distance between lines in the fill pattern. | |
void | setLineAngle (double a) |
Sets the angle for the parallel lines used to fill the symbol. | |
void | setLineWidth (double w) |
Sets the width of the line subsymbol used to render the parallel lines in the fill. | |
void | setLineWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's line width. | |
void | setLineWidthUnit (Qgis::RenderUnit unit) |
Sets the unit for the line's width. | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffset (double offset) |
Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position. | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the pattern's line offset. | |
void | setOffsetUnit (Qgis::RenderUnit unit) |
Sets the unit for the line pattern's offset. | |
void | setOutputUnit (Qgis::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. | |
void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called before the layer will be rendered for a particular feature. | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. | |
void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called after the layer has been rendered for a particular feature. | |
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. | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. | |
QImage | toTiledPatternImage () const override |
Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills. | |
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 QgsImageFillSymbolLayer | |
QgsImageFillSymbolLayer () | |
~QgsImageFillSymbolLayer () override | |
Qgis::SymbolCoordinateReference | coordinateReference () const |
Returns the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. | |
Qt::PenStyle | dxfPenStyle () const override |
Gets pen style. | |
double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets line width. | |
void | setCoordinateReference (Qgis::SymbolCoordinateReference coordinateReference) |
Sets the coordinate reference mode for fill which controls how the top left corner of the image fill is positioned relative to the feature. | |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the stroke width map unit scale. | |
void | setStrokeWidthUnit (Qgis::RenderUnit unit) |
Sets the units for the symbol's stroke width. | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Returns the stroke width map unit scale. | |
Qgis::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. | |
Public Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete | |
double | angle () const |
Returns the rotation angle of the fill symbol, in degrees clockwise. | |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
QgsFillSymbolLayer & | operator= (const QgsFillSymbolLayer &other)=delete |
void | setAngle (double angle) |
Sets the rotation angle of the pattern, in degrees clockwise. | |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
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 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 QColor | strokeColor () const |
Returns the stroke color for the symbol layer. | |
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 QgsLinePatternFillSymbolLayer from a properties map. | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsLinePatternFillSymbolLayer from a SLD element. | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. | |
Protected Member Functions | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
Applies data defined settings prior to generating the fill symbol brush. | |
Protected Member Functions inherited from QgsImageFillSymbolLayer | |
virtual bool | applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const |
Returns true if the image brush should be transformed using the render context's texture origin. | |
Protected Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QVector< QPolygonF > *rings, QgsSymbolRenderContext &context) |
Default method to render polygon. | |
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 | 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. | |
A symbol fill consisting of repeated parallel lines.
Definition at line 1465 of file qgsfillsymbollayer.h.
QgsLinePatternFillSymbolLayer::QgsLinePatternFillSymbolLayer | ( | ) |
Definition at line 2574 of file qgsfillsymbollayer.cpp.
|
overridedefault |
|
overrideprotectedvirtual |
Applies data defined settings prior to generating the fill symbol brush.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3520 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the line clipping mode, which defines how lines are clipped at the edges of shapes.
Definition at line 1677 of file qgsfillsymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3426 of file qgsfillsymbollayer.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 2595 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsLinePatternFillSymbolLayer from a properties map.
The caller takes ownership of the returned object.
Definition at line 2765 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsLinePatternFillSymbolLayer from a SLD element.
The caller takes ownership of the returned object.
Definition at line 3543 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the distance between lines in the fill pattern.
Units are retrieved by distanceUnit().
Definition at line 1526 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's line distance.
Definition at line 1605 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the distance between lines in the fill pattern.
Definition at line 1587 of file qgsfillsymbollayer.h.
|
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 2713 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsSymbolLayer.
Definition at line 2629 of file qgsfillsymbollayer.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 2879 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the angle for the parallel lines used to fill the symbol.
Angles are in degrees, clockwise from North.
Definition at line 1511 of file qgsfillsymbollayer.h.
|
inline |
Returns the width of the line subsymbol used to render the parallel lines in the fill.
Definition at line 1542 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's line width.
Definition at line 1637 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the line's width.
Definition at line 1619 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2754 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.
Units are retrieved via offsetUnit().
Definition at line 1571 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the pattern's line offset.
Definition at line 1669 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the line pattern's offset.
Definition at line 1651 of file qgsfillsymbollayer.h.
QString QgsLinePatternFillSymbolLayer::ogrFeatureStyleWidth | ( | double | widthScaleFactor | ) | const |
Definition at line 3505 of file qgsfillsymbollayer.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 QgsImageFillSymbolLayer.
Definition at line 2729 of file qgsfillsymbollayer.cpp.
|
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.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3406 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Renders the fill symbol layer for the polygon whose outer ring is defined by points, using the given render context.
The rings argument optionally specifies a list of polygon rings to render as holes.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3211 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the line clipping mode, which defines how lines are clipped at the edges of shapes.
Definition at line 1685 of file qgsfillsymbollayer.h.
|
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 2589 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the distance between lines in the fill pattern.
d | distance. Units are specified by setDistanceUnit() |
Definition at line 1519 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's line distance.
Definition at line 1596 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the distance between lines in the fill pattern.
Definition at line 1579 of file qgsfillsymbollayer.h.
|
inline |
Sets the angle for the parallel lines used to fill the symbol.
Angles are in degrees, clockwise from North.
Definition at line 1502 of file qgsfillsymbollayer.h.
void QgsLinePatternFillSymbolLayer::setLineWidth | ( | double | w | ) |
Sets the width of the line subsymbol used to render the parallel lines in the fill.
Definition at line 2583 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the map unit scale for the pattern's line width.
Definition at line 1628 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the line's width.
Definition at line 1612 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 2746 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the offset distance for lines within the fill, which is the distance to offset the parallel lines from their normal position.
Units are specified via setOffsetUnit().
Definition at line 1558 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the pattern's line offset.
Definition at line 1660 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the line pattern's offset.
Definition at line 1644 of file qgsfillsymbollayer.h.
|
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 QgsImageFillSymbolLayer.
Definition at line 2718 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 2600 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Called before the layer will be rendered for a particular feature.
This is always followed by a call to stopFeatureRender() after the feature has been completely rendered (i.e. all parts have been rendered).
The default implementation does nothing.
Reimplemented from QgsSymbolLayer.
Definition at line 2638 of file qgsfillsymbollayer.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 3178 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Called after the layer has been rendered for a particular feature.
This is always preceded by a call to startFeatureRender() just before the feature will be rendered.
The default implementation does nothing.
Reimplemented from QgsSymbolLayer.
Definition at line 2645 of file qgsfillsymbollayer.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 3202 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 2616 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Definition at line 3438 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Renders the symbol layer as an image that can be used as a seamless pattern fill for polygons, this method is used by SLD export to generate image tiles for ExternalGraphic polygon fills.
The default implementation returns a null image.
Reimplemented from QgsFillSymbolLayer.
Definition at line 2652 of file qgsfillsymbollayer.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 2621 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 2739 of file qgsfillsymbollayer.cpp.