QGIS API Documentation
3.4.15-Madeira (e83d02e274)
|
#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 |
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 | 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 | |
double | angle () const |
void | drawPreviewIcon (QgsSymbolRenderContext &context, QSize size) override |
void | setAngle (double angle) |
Public Member Functions inherited from QgsSymbolLayer | |
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 |
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 |
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... | |
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 3003 of file qgsfillsymbollayer.cpp.
|
override |
Definition at line 3014 of file qgsfillsymbollayer.cpp.
|
overrideprotectedvirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3317 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3244 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3384 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 3064 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 3295 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1479 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1540 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal displacement between rows in the pattern.
Definition at line 1537 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1482 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1558 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical displacement between rows in the pattern.
Definition at line 1555 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1473 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1504 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the horizontal distance between points in the pattern.
Definition at line 1501 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1476 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1522 of file qgsfillsymbollayer.h.
|
inline |
Returns the units for the vertical distance between points in the pattern.
Definition at line 1519 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 3353 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 3368 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 3130 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3052 of file qgsfillsymbollayer.cpp.
|
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 3033 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 3224 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3377 of file qgsfillsymbollayer.cpp.
|
inline |
Definition at line 1480 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1539 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal displacement between rows in the pattern.
unit | displacement units |
Definition at line 1530 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1483 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1557 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical displacement between rows in the pattern.
unit | displacement units |
Definition at line 1548 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1474 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1503 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the horizontal distance between points in the pattern.
unit | distance units |
Definition at line 1494 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1477 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1521 of file qgsfillsymbollayer.h.
|
inline |
Sets the units for the vertical distance between points in the pattern.
unit | distance units |
Definition at line 1512 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3043 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 3019 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 3301 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3206 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Implements QgsSymbolLayer.
Definition at line 3216 of file qgsfillsymbollayer.cpp.
|
inlineoverridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsImageFillSymbolLayer.
Definition at line 1486 of file qgsfillsymbollayer.h.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 3256 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 3358 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 1579 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1581 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1580 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1582 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1584 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1583 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1573 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1575 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1574 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1576 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1578 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1577 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 1572 of file qgsfillsymbollayer.h.