QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
A class for filling symbols with a repeated raster image. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsRasterFillSymbolLayer (const QString &imageFilePath=QString()) | |
Constructor for QgsRasterFillSymbolLayer, using a raster fill from the specified imageFilePath. | |
~QgsRasterFillSymbolLayer () override | |
QgsRasterFillSymbolLayer * | 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. | |
Qgis::SymbolCoordinateReference | coordinateMode () const |
Coordinate mode for fill. | |
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. | |
Qgis::SymbolLayerFlags | flags () const override |
Returns flags which control the symbol layer's behavior. | |
double | height () const |
Returns the height used for scaling the image used in the fill. | |
QString | imageFilePath () const |
The path to the raster image used for the fill. | |
QString | layerType () const override |
Returns a string that represents this layer type. | |
QPointF | offset () const |
Returns the offset for the fill. | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the fill's offset. | |
Qgis::RenderUnit | offsetUnit () const |
Returns the units for the fill's offset. | |
double | opacity () const |
Returns the opacity for the raster image used in the fill. | |
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 | setCoordinateMode (Qgis::SymbolCoordinateReference mode) |
Set the coordinate mode for fill. | |
void | setHeight (double height) |
Sets the height for scaling the image. | |
void | setImageFilePath (const QString &imagePath) |
Sets the path to the raster image used for the fill. | |
void | setOffset (QPointF offset) |
Sets the offset for the fill. | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the fill's offset. | |
void | setOffsetUnit (const Qgis::RenderUnit unit) |
Sets the units for the fill's offset. | |
void | setOpacity (double opacity) |
Sets the opacity for the raster image used in the fill. | |
void | setOutputUnit (Qgis::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. | |
void | setSizeMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the image's width and height. | |
void | setSizeUnit (Qgis::RenderUnit unit) |
Sets the unit for the image's width and height. | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. | |
void | setWidth (double width) |
Sets the width for scaling the image used in the fill. | |
Q_DECL_DEPRECATED void | setWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the image's width. | |
Q_DECL_DEPRECATED void | setWidthUnit (Qgis::RenderUnit unit) |
Sets the unit for the image's width. | |
const QgsMapUnitScale & | sizeMapUnitScale () const |
Returns the map unit scale for the image's width and height. | |
Qgis::RenderUnit | sizeUnit () const |
Returns the units for the image's width and height. | |
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. | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. | |
double | width () const |
Returns the width used for scaling the image used in the fill. | |
Q_DECL_DEPRECATED const QgsMapUnitScale & | widthMapUnitScale () const |
Returns the map unit scale for the image's width. | |
Q_DECL_DEPRECATED Qgis::RenderUnit | widthUnit () const |
Returns the units for the image's width. | |
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. | |
QgsMapUnitScale | mapUnitScale () const override |
Qgis::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. | |
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 | setMapUnitScale (const QgsMapUnitScale &scale) override |
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. | |
virtual QImage | toTiledPatternImage () const |
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. | |
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 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 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. | |
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. | |
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 |
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 QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates a new QgsRasterFillSymbolLayer from a properties map. | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
Creates a new QgsRasterFillSymbolLayer from a SLD element. | |
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 QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. | |
Protected Member Functions | |
bool | applyBrushTransformFromContext (QgsSymbolRenderContext *context=nullptr) const override |
Returns true if the image brush should be transformed using the render context's texture origin. | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
Applies data defined settings prior to generating the fill symbol brush. | |
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 class for filling symbols with a repeated raster image.
Definition at line 855 of file qgsfillsymbollayer.h.
QgsRasterFillSymbolLayer::QgsRasterFillSymbolLayer | ( | const QString & | imageFilePath = QString() | ) |
Constructor for QgsRasterFillSymbolLayer, using a raster fill from the specified imageFilePath.
Definition at line 5103 of file qgsfillsymbollayer.cpp.
|
overridedefault |
|
overrideprotectedvirtual |
Returns true
if the image brush should be transformed using the render context's texture origin.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 5420 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Applies data defined settings prior to generating the fill symbol brush.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 5363 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 5306 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 5336 of file qgsfillsymbollayer.cpp.
|
inline |
Coordinate mode for fill.
Controls how the top left corner of the image fill is positioned relative to the feature.
Definition at line 931 of file qgsfillsymbollayer.h.
|
static |
Creates a new QgsRasterFillSymbolLayer from a properties map.
The caller takes ownership of the returned object.
Definition at line 5113 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsRasterFillSymbolLayer from a SLD element.
The caller takes ownership of the returned object.
Definition at line 5179 of file qgsfillsymbollayer.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 5325 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns flags which control the symbol layer's behavior.
Reimplemented from QgsSymbolLayer.
Definition at line 5234 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the height used for scaling the image used in the fill.
If the height is 0 then the height will be calculated automatically based on the image's width().
Definition at line 1049 of file qgsfillsymbollayer.h.
|
inline |
The path to the raster image used for the fill.
Definition at line 915 of file qgsfillsymbollayer.h.
|
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 5229 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset for the fill.
Definition at line 963 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the fill's offset.
Definition at line 999 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 981 of file qgsfillsymbollayer.h.
|
inline |
Returns the opacity for the raster image used in the fill.
Definition at line 945 of file qgsfillsymbollayer.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.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 5287 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 5239 of file qgsfillsymbollayer.cpp.
|
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 5211 of file qgsfillsymbollayer.cpp.
void QgsRasterFillSymbolLayer::setCoordinateMode | ( | Qgis::SymbolCoordinateReference | mode | ) |
Set the coordinate mode for fill.
Controls how the top left corner of the image fill is positioned relative to the feature.
mode | coordinate mode |
Definition at line 5353 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the height for scaling the image.
If height is 0 then the height will be calculated automatically based on the image's width().
Definition at line 1037 of file qgsfillsymbollayer.h.
void QgsRasterFillSymbolLayer::setImageFilePath | ( | const QString & | imagePath | ) |
Sets the path to the raster image used for the fill.
imagePath | path to image file |
Definition at line 5348 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the offset for the fill.
offset | offset for fill |
Definition at line 954 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the fill's offset.
scale | map unit scale for offset |
Definition at line 990 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the fill's offset.
unit | units for offset |
Definition at line 972 of file qgsfillsymbollayer.h.
void QgsRasterFillSymbolLayer::setOpacity | ( | double | opacity | ) |
Sets the opacity for the raster image used in the fill.
opacity | opacity value between 0 (fully transparent) and 1 (fully opaque) |
Definition at line 5358 of file qgsfillsymbollayer.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 QgsImageFillSymbolLayer.
Definition at line 5341 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the map unit scale for the image's width and height.
Definition at line 1117 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the image's width and height.
Definition at line 1071 of file qgsfillsymbollayer.h.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 5223 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the width for scaling the image used in the fill.
If width is 0 then the width will be calculated automatically based on the image's height().
Definition at line 1012 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the image's width.
Definition at line 1105 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit for the image's width.
Definition at line 1060 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the image's width and height.
Definition at line 1140 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the image's width and height.
Definition at line 1094 of file qgsfillsymbollayer.h.
|
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 5277 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 5282 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 900 of file qgsfillsymbollayer.h.
|
overridevirtual |
Returns true
if the symbol layer has any components which use map unit based sizes.
Reimplemented from QgsSymbolLayer.
Definition at line 5330 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the width used for scaling the image used in the fill.
If the width is 0 then the width will be calculated automatically based on the image's height().
Definition at line 1024 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the image's width.
Definition at line 1128 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the image's width.
Definition at line 1082 of file qgsfillsymbollayer.h.