QGIS API Documentation
3.10.0-A Coruña (6c816b4204)
|
#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... | |
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 | 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 |
void | stopRender (QgsSymbolRenderContext &context) override |
QgsSymbol * | subSymbol () override |
Returns the symbol's sub symbol, if present. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QgsStringMap &props) const override |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns the set of attributes referenced by the layer. 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... | |
void | renderPolygon (const QPolygonF &points, QList< QPolygonF > *rings, QgsSymbolRenderContext &context) override |
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 () |
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 |
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) |
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 QColor | strokeColor () const |
Gets stroke color. More... | |
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 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 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... | |
Definition at line 1449 of file qgsfillsymbollayer.h.
QgsPointPatternFillSymbolLayer::QgsPointPatternFillSymbolLayer | ( | ) |
Definition at line 2998 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 3011 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3367 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3294 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3446 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 3067 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 3345 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1479 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1574 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal displacement between rows in the pattern.
Definition at line 1571 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1482 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1592 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical displacement between rows in the pattern.
Definition at line 1589 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1473 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1538 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal distance between points in the pattern.
Definition at line 1535 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1476 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1556 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical distance between points in the pattern.
Definition at line 1553 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 3415 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 3430 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 3158 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3053 of file qgsfillsymbollayer.cpp.
|
inline |
Returns the horizontal offset values for points in the pattern.
Definition at line 1500 of file qgsfillsymbollayer.h.
|
inline |
Returns the unit scale for the horizontal offset for rows in the pattern.
Definition at line 1626 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal offset for rows in the pattern.
Definition at line 1609 of file qgsfillsymbollayer.h.
|
inline |
Returns the vertical offset values for points in the pattern.
Definition at line 1517 of file qgsfillsymbollayer.h.
|
inline |
Returns the unit scale for the vertical offset between rows in the pattern.
Definition at line 1660 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical offset for rows in the pattern.
Definition at line 1643 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 3032 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 3268 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3439 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1480 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1573 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal displacement between rows in the pattern.
unit | displacement units |
Definition at line 1564 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1483 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1591 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical displacement between rows in the pattern.
unit | displacement units |
Definition at line 1582 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1474 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1537 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal distance between points in the pattern.
unit | distance units |
Definition at line 1528 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1477 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1555 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical distance between points in the pattern.
unit | distance units |
Definition at line 1546 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3042 of file qgsfillsymbollayer.cpp.
|
inline |
Sets the horizontal offset values for points in the pattern.
offset | offset value |
Definition at line 1492 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 1618 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal offset between rows in the pattern.
unit | offset units |
Definition at line 1601 of file qgsfillsymbollayer.h.
|
inline |
Sets the vertical offset values for points in the pattern.
offset | offset value |
Definition at line 1509 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 1652 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical offset for rows in the pattern.
unit | offset units |
Definition at line 1635 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 3016 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3351 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3250 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3260 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 1520 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 3306 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 3420 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 1681 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1683 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1682 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1684 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1686 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1685 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1675 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1677 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1676 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1678 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1680 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1679 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1674 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1687 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1689 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1688 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1690 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1692 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1691 of file qgsfillsymbollayer.h.