QGIS API Documentation
3.2.0-Bonn (bc43194)
|
A class for filling symbols with a repeated raster image. More...
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsRasterFillSymbolLayer (const QString &imageFilePath=QString()) | |
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... | |
QgsStringMap | 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, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
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 |
void | stopRender (QgsSymbolRenderContext &context) override |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. 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 () | |
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... | |
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) |
void | setStrokeWidthUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the symbol's stroke width. More... | |
const QgsMapUnitScale & | strokeWidthMapUnitScale () const |
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 | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
virtual | ~QgsSymbolLayer () |
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 |
virtual QString | ogrFeatureStyle (double mmScaleFactor, double mapUnitScaleFactor) const |
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 |
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) |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the layer. More... | |
void | setRenderingPass (int renderingPass) |
virtual void | setStrokeColor (const QColor &color) |
Set stroke color. More... | |
virtual QColor | strokeColor () const |
Gets stroke color. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const |
QgsSymbol::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 QgsStringMap &properties=QgsStringMap()) |
static void | resolvePaths (QgsStringMap &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 | |
void | applyDataDefinedSettings (QgsSymbolRenderContext &context) override |
Protected Member Functions inherited from QgsFillSymbolLayer | |
QgsFillSymbolLayer (bool locked=false) | |
void | _renderPolygon (QPainter *p, const QPolygonF &points, const QList< QPolygonF > *rings, QgsSymbolRenderContext &context) |
Default method to render polygon. More... | |
Protected Member Functions inherited from QgsSymbolLayer | |
QgsSymbolLayer (QgsSymbol::SymbolType type, bool locked=false) | |
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 QgsStringMap &stringMap) |
Restores older data defined properties from string map. More... | |
Additional Inherited Members | |
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 696 of file qgsfillsymbollayer.h.
Enumerator | |
---|---|
Feature | |
Viewport |
Definition at line 700 of file qgsfillsymbollayer.h.
QgsRasterFillSymbolLayer::QgsRasterFillSymbolLayer | ( | const QString & | imageFilePath = QString() | ) |
Definition at line 3571 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3754 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3717 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 758 of file qgsfillsymbollayer.h.
|
static |
Definition at line 3578 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 3734 of file qgsfillsymbollayer.cpp.
|
inline |
The path to the raster image used for the fill.
Definition at line 742 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 3657 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the offset for the fill.
Definition at line 790 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the fill's offset.
Definition at line 826 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the fill's offset.
Definition at line 808 of file qgsfillsymbollayer.h.
|
inline |
Returns the opacity for the raster image used in the fill.
Definition at line 772 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 3701 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3662 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 3639 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 3744 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 3739 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the offset for the fill.
offset | offset for fill |
Definition at line 781 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the fill's offset.
scale | map unit scale for offset |
Definition at line 817 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the fill's offset.
unit | units for offset |
Definition at line 799 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 3749 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3651 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 836 of file qgsfillsymbollayer.h.
|
inline |
Sets the map unit scale for the image's width.
scale | map unit scale for width |
Definition at line 873 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the image's width.
unit | units for width |
Definition at line 855 of file qgsfillsymbollayer.h.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3691 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3696 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 727 of file qgsfillsymbollayer.h.
|
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 846 of file qgsfillsymbollayer.h.
|
inline |
Returns the map unit scale for the image's width.
Definition at line 882 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the image's width.
Definition at line 864 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 888 of file qgsfillsymbollayer.h.
|
protected |
Path to the image file.
Definition at line 887 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 891 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 893 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 892 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 889 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 895 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 897 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 896 of file qgsfillsymbollayer.h.