QGIS API Documentation
3.20.0-Odense (decaadbb31)
|
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsPointPatternFillSymbolLayer () | |
~QgsPointPatternFillSymbolLayer () override | |
QgsPointPatternFillSymbolLayer * | clone () const override |
Shall be reimplemented by subclasses to create a deep copy of the instance. More... | |
QColor | color () const override |
The fill color. More... | |
double | displacementX () const |
const QgsMapUnitScale & | displacementXMapUnitScale () const |
QgsUnitTypes::RenderUnit | displacementXUnit () const |
Returns the units for the horizontal displacement between rows in the pattern. More... | |
double | displacementY () const |
const QgsMapUnitScale & | displacementYMapUnitScale () const |
QgsUnitTypes::RenderUnit | displacementYUnit () const |
Returns the units for the vertical displacement between rows in the pattern. More... | |
double | distanceX () const |
const QgsMapUnitScale & | distanceXMapUnitScale () const |
QgsUnitTypes::RenderUnit | distanceXUnit () const |
Returns the units for the horizontal distance between points in the pattern. More... | |
double | distanceY () const |
const QgsMapUnitScale & | distanceYMapUnitScale () const |
QgsUnitTypes::RenderUnit | distanceYUnit () const |
Returns the units for the vertical distance between points in the pattern. 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... | |
bool | hasDataDefinedProperties () const override |
Returns true if the symbol layer (or any of its sub-symbols) contains data defined properties. More... | |
QString | layerType () const override |
Returns a string that represents this layer type. More... | |
QgsMapUnitScale | mapUnitScale () const override |
double | offsetX () const |
Returns the horizontal offset values for points in the pattern. More... | |
const QgsMapUnitScale & | offsetXMapUnitScale () const |
Returns the unit scale for the horizontal offset for rows in the pattern. More... | |
QgsUnitTypes::RenderUnit | offsetXUnit () const |
Returns the units for the horizontal offset for rows in the pattern. More... | |
double | offsetY () const |
Returns the vertical offset values for points in the pattern. More... | |
const QgsMapUnitScale & | offsetYMapUnitScale () const |
Returns the unit scale for the vertical offset between rows in the pattern. More... | |
QgsUnitTypes::RenderUnit | offsetYUnit () const |
Returns the units for the vertical offset for rows in the pattern. More... | |
QgsUnitTypes::RenderUnit | outputUnit () const override |
Returns the units to use for sizes and widths within the symbol layer. 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 | setColor (const QColor &c) override |
The fill color. More... | |
void | setDisplacementX (double d) |
void | setDisplacementXMapUnitScale (const QgsMapUnitScale &scale) |
void | setDisplacementXUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the horizontal displacement between rows in the pattern. More... | |
void | setDisplacementY (double d) |
void | setDisplacementYMapUnitScale (const QgsMapUnitScale &scale) |
void | setDisplacementYUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the vertical displacement between rows in the pattern. More... | |
void | setDistanceX (double d) |
void | setDistanceXMapUnitScale (const QgsMapUnitScale &scale) |
void | setDistanceXUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the horizontal distance between points in the pattern. More... | |
void | setDistanceY (double d) |
void | setDistanceYMapUnitScale (const QgsMapUnitScale &scale) |
void | setDistanceYUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the vertical distance between points in the pattern. More... | |
void | setMapUnitScale (const QgsMapUnitScale &scale) override |
void | setOffsetX (double offset) |
Sets the horizontal offset values for points in the pattern. More... | |
void | setOffsetXMapUnitScale (const QgsMapUnitScale &scale) |
Sets the unit scale for the horizontal offset for rows in the pattern. More... | |
void | setOffsetXUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the horizontal offset between rows in the pattern. More... | |
void | setOffsetY (double offset) |
Sets the vertical offset values for points in the pattern. More... | |
void | setOffsetYMapUnitScale (const QgsMapUnitScale &scale) |
Sets the unit scale for the vertical offset for rows in the pattern. More... | |
void | setOffsetYUnit (QgsUnitTypes::RenderUnit unit) |
Sets the units for the vertical offset for rows in the pattern. More... | |
void | setOutputUnit (QgsUnitTypes::RenderUnit unit) override |
Sets the units to use for sizes and widths within the symbol layer. More... | |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. 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... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props) const override |
Saves the symbol layer as SLD. More... | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. More... | |
bool | usesMapUnits () const override |
Returns true if the symbol layer has any components which use map unit based sizes. 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... | |
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... | |
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... | |
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... | |
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... | |
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 QgsPointPatternFillSymbolLayer using the specified properties map containing symbol properties (see properties()). More... | |
static QgsSymbolLayer * | createFromSld (QDomElement &element) |
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 QgsImageFillSymbolLayer | |
virtual bool | applyBrushTransformFromContext () const |
Returns true if the image brush should be transformed using the render context's texture origin. More... | |
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... | |
Definition at line 1561 of file qgsfillsymbollayer.h.
QgsPointPatternFillSymbolLayer::QgsPointPatternFillSymbolLayer | ( | ) |
Definition at line 3162 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 3175 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3713 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3631 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3793 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsPointPatternFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
Definition at line 3241 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 3686 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1596 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1691 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal displacement between rows in the pattern.
Definition at line 1688 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1599 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1709 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical displacement between rows in the pattern.
Definition at line 1706 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1590 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1655 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal distance between points in the pattern.
Definition at line 1652 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1593 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1673 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical distance between points in the pattern.
Definition at line 1670 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 QgsImageFillSymbolLayer.
Definition at line 3762 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3777 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 3332 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3227 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the horizontal offset values for points in the pattern.
Definition at line 1617 of file qgsfillsymbollayer.h.
|
inline |
Returns the unit scale for the horizontal offset for rows in the pattern.
Definition at line 1743 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal offset for rows in the pattern.
Definition at line 1726 of file qgsfillsymbollayer.h.
|
inline |
Returns the vertical offset values for points in the pattern.
Definition at line 1634 of file qgsfillsymbollayer.h.
|
inline |
Returns the unit scale for the vertical offset between rows in the pattern.
Definition at line 1777 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical offset for rows in the pattern.
Definition at line 1760 of file qgsfillsymbollayer.h.
|
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 3196 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.
Implements QgsSymbolLayer.
Definition at line 3605 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 3464 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3786 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1597 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1690 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal displacement between rows in the pattern.
unit | displacement units |
Definition at line 1681 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1600 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1708 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical displacement between rows in the pattern.
unit | displacement units |
Definition at line 1699 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1591 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1654 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal distance between points in the pattern.
unit | distance units |
Definition at line 1645 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1594 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1672 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical distance between points in the pattern.
unit | distance units |
Definition at line 1663 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3216 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the horizontal offset values for points in the pattern.
offset | offset value |
Definition at line 1609 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit scale for the horizontal offset for rows in the pattern.
scale | offset unit scale |
Definition at line 1735 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal offset between rows in the pattern.
unit | offset units |
Definition at line 1718 of file qgsfillsymbollayer.h.
|
inline |
Sets the vertical offset values for points in the pattern.
offset | offset value |
Definition at line 1626 of file qgsfillsymbollayer.h.
|
inline |
Sets the unit scale for the vertical offset for rows in the pattern.
scale | offset unit scale |
Definition at line 1769 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical offset for rows in the pattern.
unit | offset units |
Definition at line 1752 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 3180 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3692 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 3429 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 3451 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3708 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Saves the symbol layer as SLD.
Reimplemented from QgsSymbolLayer.
Definition at line 3643 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 QgsImageFillSymbolLayer.
Definition at line 3767 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 3206 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 1799 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1801 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1800 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1802 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1804 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1803 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1793 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1795 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1794 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1796 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1798 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1797 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1792 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1805 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1807 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1806 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1808 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1810 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1809 of file qgsfillsymbollayer.h.