QGIS API Documentation
3.14.0-Pi (9f7028fd23)
|
#include <qgsfillsymbollayer.h>
Public Member Functions | |
QgsCentroidFillSymbolLayer () | |
bool | clipOnCurrentPartOnly () const |
Returns true if point markers should be clipped to the current part boundary only. More... | |
bool | clipPoints () const |
Returns true if point markers should be clipped to the polygon boundary. More... | |
QgsCentroidFillSymbolLayer * | 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... | |
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... | |
bool | pointOnAllParts () const |
Returns whether a point is drawn for all parts or only on the biggest part of multi-part features. More... | |
bool | pointOnSurface () const |
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, 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 | setClipOnCurrentPartOnly (bool clipOnCurrentPartOnly) |
Sets whether point markers should be clipped to the current part boundary only. More... | |
void | setClipPoints (bool clipPoints) |
Sets whether point markers should be clipped to the polygon boundary. More... | |
void | setColor (const QColor &color) override |
The fill color. 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 | setPointOnAllParts (bool pointOnAllParts) |
Sets whether a point is drawn for all parts or only on the biggest part of multi-part features. More... | |
void | setPointOnSurface (bool pointOnSurface) |
bool | setSubSymbol (QgsSymbol *symbol) override |
Sets layer's subsymbol. takes ownership of the passed symbol. More... | |
void | startFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called before the layer will be rendered for a particular feature. More... | |
void | startRender (QgsSymbolRenderContext &context) override |
Called before a set of rendering operations commences on the supplied render context. More... | |
void | stopFeatureRender (const QgsFeature &feature, QgsRenderContext &context) override |
Called after the layer has been rendered for a particular feature. 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 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 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 QColor | dxfColor (QgsSymbolRenderContext &context) const |
Gets color. 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... | |
virtual Qt::PenStyle | dxfPenStyle () const |
Gets pen style. More... | |
virtual double | dxfWidth (const QgsDxfExport &e, QgsSymbolRenderContext &context) const |
Gets line width. More... | |
bool | enabled () const |
Returns true if symbol layer is enabled and will be drawn. More... | |
virtual double | estimateMaxBleed (const QgsRenderContext &context) const |
Returns the estimated maximum distance which the layer style will bleed outside the drawn shape when drawn in the specified /a context. 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 QgsSymbolLayerReferenceList | 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) |
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()) |
Creates a new QgsCentroidFillSymbolLayer 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 Attributes | |
int | mBiggestPartIndex = -1 |
bool | mClipOnCurrentPartOnly = false |
bool | mClipPoints = false |
QgsFeatureId | mCurrentFeatureId = -1 |
std::unique_ptr< QgsMarkerSymbol > | mMarker |
bool | mPointOnAllParts = true |
bool | mPointOnSurface = false |
bool | mRenderingFeature = false |
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 |
QgsSymbol::SymbolType | mType |
Definition at line 1925 of file qgsfillsymbollayer.h.
QgsCentroidFillSymbolLayer::QgsCentroidFillSymbolLayer | ( | ) |
Definition at line 3641 of file qgsfillsymbollayer.cpp.
|
inline |
Returns true
if point markers should be clipped to the current part boundary only.
Definition at line 2008 of file qgsfillsymbollayer.h.
|
inline |
Returns true
if point markers should be clipped to the polygon boundary.
Definition at line 1992 of file qgsfillsymbollayer.h.
|
overridevirtual |
Shall be reimplemented by subclasses to create a deep copy of the instance.
Implements QgsSymbolLayer.
Definition at line 3821 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3675 of file qgsfillsymbollayer.cpp.
|
static |
Creates a new QgsCentroidFillSymbolLayer using the specified properties map containing symbol properties (see properties()).
Caller takes ownership of the returned symbol layer.
Definition at line 3646 of file qgsfillsymbollayer.cpp.
|
static |
Definition at line 3844 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns true
if the symbol layer (or any of its sub-symbols) contains data defined properties.
Reimplemented from QgsSymbolLayer.
Definition at line 3889 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 3664 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 3923 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 QgsSymbolLayer.
Definition at line 3906 of file qgsfillsymbollayer.cpp.
|
inline |
Returns whether a point is drawn for all parts or only on the biggest part of multi-part features.
Definition at line 1984 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1972 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 3811 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.
Implements QgsFillSymbolLayer.
Definition at line 3694 of file qgsfillsymbollayer.cpp.
|
inline |
Sets whether point markers should be clipped to the current part boundary only.
Definition at line 2016 of file qgsfillsymbollayer.h.
|
inline |
Sets whether point markers should be clipped to the polygon boundary.
Definition at line 2000 of file qgsfillsymbollayer.h.
|
overridevirtual |
The fill color.
Reimplemented from QgsSymbolLayer.
Definition at line 3669 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 3915 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 QgsSymbolLayer.
Definition at line 3898 of file qgsfillsymbollayer.cpp.
|
inline |
Sets whether a point is drawn for all parts or only on the biggest part of multi-part features.
Definition at line 1978 of file qgsfillsymbollayer.h.
|
inline |
Definition at line 1971 of file qgsfillsymbollayer.h.
|
overridevirtual |
Sets layer's subsymbol. takes ownership of the passed symbol.
Reimplemented from QgsSymbolLayer.
Definition at line 3866 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Called before the layer will be rendered for a particular feature.
This is always followed by a call to stopFeatureRender() after the feature has been completely rendered (i.e. all parts have been rendered).
The default implementation does nothing.
Reimplemented from QgsSymbolLayer.
Definition at line 3714 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 3680 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Called after the layer has been rendered for a particular feature.
This is always preceded by a call to startFeatureRender() just before the feature will be rendered.
The default implementation does nothing.
Reimplemented from QgsSymbolLayer.
Definition at line 3720 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 3689 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Returns the symbol's sub symbol, if present.
Reimplemented from QgsSymbolLayer.
Definition at line 3861 of file qgsfillsymbollayer.cpp.
|
overridevirtual |
Reimplemented from QgsSymbolLayer.
Definition at line 3836 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 QgsSymbolLayer.
Definition at line 3879 of file qgsfillsymbollayer.cpp.
|
protected |
Definition at line 2032 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2027 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2026 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2031 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2023 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2025 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2024 of file qgsfillsymbollayer.h.
|
protected |
Definition at line 2029 of file qgsfillsymbollayer.h.