QGIS API Documentation
3.20.0-Odense (decaadbb31)
|
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. More... | |
~QgsRasterFillSymbolLayer () override | |
QgsRasterFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
FillCoordinateMode | coordinateMode () const |
Coordinate mode for fill. More... | |
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. More... | |
QString | imageFilePath () const |
The path to the raster image used for the fill. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QPointF | offset () const |
Returns the offset for the fill. More... | |
const QgsMapUnitScale & | offsetMapUnitScale () const |
Returns the map unit scale for the fill's offset. More... | |
QgsUnitTypes::RenderUnit | offsetUnit () const |
Returns the units for the fill's offset. More... | |
double | opacity () const |
Returns the opacity for the raster image used in the fill. More... | |
QVariantMap | properties () const override |
Should be reimplemented by subclasses to return a string map that contains the configuration information for the symbol layer. More... | |
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. More... | |
void | setCoordinateMode (FillCoordinateMode mode) |
Set the coordinate mode for fill. More... | |
void | setImageFilePath (const QString &imagePath) |
Sets the path to the raster image used for the fill. More... | |
void | setOffset (QPointF offset) |
Sets the offset for the fill. More... | |
void | setOffsetMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the fill's offset. More... | |
void | setOffsetUnit (const QgsUnitTypes::RenderUnit unit) |
Sets the units for the fill's offset. More... | |
void | setOpacity (double opacity) |
Sets the opacity for the raster image used in the fill. More... | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
void | setWidth (const double width) |
Sets the width for scaling the image used in the fill. More... | |
void | setWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the map unit scale for the image's width. More... | |
void | setWidthUnit (const QgsUnitTypes::RenderUnit unit) |
Sets the units for the image's width. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopRender (QgsSymbolRenderContext &context) override |
Called after a set of rendering operations has finished on the supplied render context. More... | |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. More... | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. More... | |
double | width () const |
Returns the width used for scaling the image used in the fill. More... | |
const QgsMapUnitScale & | widthMapUnitScale () const |
Returns the map unit scale for the image's width. More... | |
QgsUnitTypes::RenderUnit | widthUnit () const |
Returns the units for the image's width. More... | |
Public Member Functions inherited from QgsImageFillSymbolLayer | |
QgsImageFillSymbolLayer () | |
~QgsImageFillSymbolLayer () override | |
QColor | dxfColor (QgsSymbolRenderContext &context) const override |
Gets color. More... | |
Qt::PenStyle | dxfPenStyle () const override |
Gets pen style. More... | |
double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const override |
Gets line width. More... | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
QgsMapUnitScale | mapUnitScale () const override |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
void | setStrokeWidthMapUnitScale (const QgsMapUnitScale &scale) |
Sets the stroke width map unit scale. More... | |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units fo the symbol's stroke width. More... | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
Returns the stroke width map unit scale. More... | |
QgsUnitTypes::RenderUnit | strokeWidthUnit () const |
Returns the units for the symbol's stroke width. More... | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. More... | |
Public Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (const QgsFillSymbolLayer &other)=delete | |
QgsFillSymbolLayer cannot be copied. More... | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
QgsFillSymbolLayer & | operator= (const QgsFillSymbolLayer &other)=delete |
QgsFillSymbolLayer cannot be copied. More... | |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (const QgsSymbolLayer &other)=delete | |
QgsSymbolLayer cannot be copied. More... | |
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. More... | |
virtual QColor | color () const |
The fill color. More... | |
QgsPropertyCollection & | dataDefinedProperties () |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
const QgsPropertyCollection & | dataDefinedProperties () const |
Returns a reference to the symbol layer's property collection, used for data defined overrides. More... | |
virtual double | dxfAngle (QgsSymbolRenderContext &context) const |
Gets angle. More... | |
virtual QColor | dxfBrushColor (QgsSymbolRenderContext &context) const |
Gets brush/fill color. More... | |
virtual Qt::BrushStyle | dxfBrushStyle () const |
Gets brush/fill style. More... | |
virtual QVector< qreal > | dxfCustomDashPattern (QgsUnitTypes::RenderUnit &unit) const |
Gets dash pattern. More... | |
virtual double | dxfOffset (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets offset. More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. More... | |
virtual QColor | fillColor () const |
Gets fill color. More... | |
virtual bool | isCompatibleWithSymbol (QgsSymbol *symbol) const |
Returns if the layer can be used below the specified symbol. More... | |
bool | isLocked () const |
Returns true if the symbol layer colors are locked and the layer will ignore any symbol-level color changes. More... | |
virtual QList< QgsSymbolLayerReference > | masks () const |
Returns masks defined by this symbol layer. More... | |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
QgsSymbolLayer & | operator= (const QgsSymbolLayer &other)=delete |
QgsSymbolLayer cannot be copied. More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the layer. More... | |
virtual void | prepareExpressions (const QgsSymbolRenderContext &context) |
Prepares all data defined property expressions for evaluation. More... | |
int | renderingPass () const |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual void | setColor (const QColor &color) |
The fill color. More... | |
void | setDataDefinedProperties (const QgsPropertyCollection &collection) |
Sets the symbol layer's property collection, used for data defined overrides. More... | |
virtual void | setDataDefinedProperty (Property key, const QgsProperty &property) |
Sets a data defined property for the layer. More... | |
void | setEnabled (bool enabled) |
Sets whether symbol layer is enabled and should be drawn. More... | |
virtual void | setFillColor (const QColor &color) |
Set fill color. More... | |
void | setLocked (bool locked) |
Sets whether the layer's colors are locked. More... | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
Specifies the rendering pass in which this symbol layer should be rendered. More... | |
virtual void | setStrokeColor (const QColor &color) |
Set stroke color. More... | |
virtual void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called before the layer will be rendered for a particular feature. More... | |
virtual void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) |
Called after the layer has been rendered for a particular feature. More... | |
virtual QColor | strokeColor () const |
Gets stroke color. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const |
Saves the symbol layer as SLD. More... | |
Qgis::SymbolType | type () const |
virtual bool | writeDxf (QgsDxfExport &e, double mmMapUnitScaleFactor, const QString &layerName, QgsSymbolRenderContext &context, QPointF shift=QPointF(0.0, 0.0)) const |
write as DXF More... | |
Static Public Member Functions | |
static QgsSymbolLayer * | create (const QVariantMap &properties=QVariantMap()) |
Creates a new QgsRasterFillSymbolLayer from a properties map. More... | |
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. More... | |
Static Public Member Functions inherited from QgsSymbolLayer | |
static const QgsPropertiesDefinition & | propertyDefinitions () |
Returns the symbol layer property definitions. More... | |
Protected Member Functions | |
bool | applyBrushTransformFromContext () const override |
Returns true if the image brush should be transformed using the render context's texture origin. More... | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
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. More... | |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (Qgis::SymbolType type, bool locked=false) | |
Constructor for QgsSymbolLayer. More... | |
void | copyDataDefinedProperties (QgsSymbolLayer *destLayer) const |
Copies all data defined properties of this layer to another symbol layer. More... | |
void | copyPaintEffect (QgsSymbolLayer *destLayer) const |
Copies paint effect of this layer to another symbol layer. More... | |
void | restoreOldDataDefinedProperties (const QVariantMap &stringMap) |
Restores older data defined properties from string map. More... | |
Additional Inherited Members | |
Protected Attributes inherited from QgsImageFillSymbolLayer | |
QBrush | mBrush |
double | mNextAngle = 0.0 |
std::unique_ptr< QgsLineSymbol > | mStroke |
Custom stroke. More... | |
double | mStrokeWidth = 0.0 |
Stroke width. More... | |
QgsMapUnitScale | mStrokeWidthMapUnitScale |
QgsUnitTypes::RenderUnit | mStrokeWidthUnit = QgsUnitTypes::RenderMillimeters |
Protected Attributes inherited from QgsFillSymbolLayer | |
double | mAngle = 0.0 |
Protected Attributes inherited from QgsSymbolLayer | |
QColor | mColor |
QgsPropertyCollection | mDataDefinedProperties |
bool | mEnabled = true |
True if layer is enabled and should be drawn. More... | |
QgsFields | mFields |
bool | mLocked = false |
std::unique_ptr< QgsPaintEffect > | mPaintEffect |
int | mRenderingPass = 0 |
Qgis::SymbolType | mType |
Static Protected Attributes inherited from QgsSymbolLayer | |
static const bool | SELECT_FILL_BORDER = false |
Whether fill styles for selected features also highlight symbol stroke. More... | |
static const bool | SELECT_FILL_STYLE = false |
Whether fill styles for selected features uses symbol layer style. More... | |
static const bool | SELECTION_IS_OPAQUE = true |
Whether styles for selected features ignore symbol alpha. More... | |
A class for filling symbols with a repeated raster image.
Definition at line 800 of file qgsfillsymbollayer.h.
Fill coordinate modes, dictates fill tiling behavior.
Enumerator | |
---|---|
Feature | Tiling is based on feature bounding box. |
Viewport | Tiling is based on complete map viewport. |
Definition at line 805 of file qgsfillsymbollayer.h.
QgsRasterFillSymbolLayer::QgsRasterFillSymbolLayer | ( | const QString & | imageFilePath = QString() | ) |
Constructor for QgsRasterFillSymbolLayer, using a raster fill from the specified imageFilePath.
Definition at line 4120 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 4370 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 4320 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 4277 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 874 of file qgsfillsymbollayer.h.
|
static |
Creates a new QgsRasterFillSymbolLayer from a properties map.
The caller takes ownership of the returned object.
Definition at line 4129 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 QgsImageFillSymbolLayer.
Definition at line 4294 of file qgsfillsymbollayer.cpp.
|
inline |
The path to the raster image used for the fill.
Definition at line 858 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 4208 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset for the fill.
Definition at line 906 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the fill's offset.
Definition at line 942 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 924 of file qgsfillsymbollayer.h.
|
inline |
Returns the opacity for the raster image used in the fill.
Definition at line 888 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.
Implements QgsSymbolLayer.
Definition at line 4261 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 4213 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 4190 of file qgsfillsymbollayer.cpp.
void QgsRasterFillSymbolLayer::setCoordinateMode | ( | const QgsRasterFillSymbolLayer::FillCoordinateMode | 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 4310 of file qgsfillsymbollayer.cpp.
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 4305 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the offset for the fill.
offset | offset for fill |
Definition at line 897 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the fill's offset.
scale | map unit scale for offset |
Definition at line 933 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the fill's offset.
unit | units for offset |
Definition at line 915 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 4315 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 4202 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the width for scaling the image used in the fill.
The image's height will also be scaled to maintain the image's aspect ratio.
width | width for scaling the image |
Definition at line 952 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the image's width.
scale | map unit scale for width |
Definition at line 989 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the image's width.
unit | units for width |
Definition at line 971 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 4251 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 4256 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 843 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 4299 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the width used for scaling the image used in the fill.
The image's height is scaled to maintain the image's aspect ratio.
Definition at line 962 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the image's width.
Definition at line 998 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the image's width.
Definition at line 980 of file qgsfillsymbollayer.h.