QGIS API Documentation 3.32.0-Lima (311a8cb8a6)
|
#include <qgsrulebasedrenderer.h>
Classes | |
struct | FeatureToRender |
Feature for rendering by a QgsRuleBasedRenderer. More... | |
struct | RenderJob |
A QgsRuleBasedRenderer rendering job, consisting of a feature to be rendered with a particular symbol. More... | |
struct | RenderLevel |
Render level: a list of jobs to be drawn at particular level for a QgsRuleBasedRenderer. More... | |
class | Rule |
This class keeps data about a rules for rule-based renderer. More... | |
Public Types | |
enum | FeatureFlags { FeatIsSelected = 1 , FeatDrawMarkers = 2 } |
typedef QList< QgsRuleBasedRenderer::RenderLevel > | RenderQueue |
Rendering queue: a list of rendering levels. More... | |
typedef QList< QgsRuleBasedRenderer::Rule * > | RuleList |
![]() | |
enum | Capability { SymbolLevels = 1 , MoreSymbolsPerFeature = 1 << 2 , Filter = 1 << 3 , ScaleDependent = 1 << 4 } |
Used to specify details about a renderer. More... | |
Public Member Functions | |
QgsRuleBasedRenderer (QgsRuleBasedRenderer::Rule *root) | |
Constructs the renderer from given tree of rules (takes ownership) More... | |
QgsRuleBasedRenderer (QgsSymbol *defaultSymbol) | |
Constructor for convenience. Creates a root rule and adds a default rule with symbol (takes ownership) More... | |
~QgsRuleBasedRenderer () override | |
bool | accept (QgsStyleEntityVisitorInterface *visitor) const override |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More... | |
bool | canSkipRender () override |
Returns true if the renderer can be entirely skipped, i.e. More... | |
QgsFeatureRenderer::Capabilities | capabilities () override |
Returns details about internals of this renderer. More... | |
void | checkLegendSymbolItem (const QString &key, bool state=true) override |
Sets whether the legend symbology item with the specified ley should be checked. More... | |
QgsRuleBasedRenderer * | clone () const override |
Create a deep copy of this renderer. More... | |
QString | dump () const override |
Returns debug information about this renderer. More... | |
QString | filter (const QgsFields &fields=QgsFields()) override |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More... | |
bool | filterNeedsGeometry () const override |
Returns true if this renderer requires the geometry to apply the filter. More... | |
QSet< QString > | legendKeysForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns legend keys matching a specified feature. More... | |
QString | legendKeyToExpression (const QString &key, QgsVectorLayer *layer, bool &ok) const override |
Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key. More... | |
bool | legendSymbolItemChecked (const QString &key) override |
Returns true if the legend symbology item with the specified key is checked. More... | |
QgsLegendSymbolList | legendSymbolItems () const override |
Returns a list of symbology items for the legend. More... | |
bool | legendSymbolItemsCheckable () const override |
Returns true if symbology items in legend are checkable. More... | |
QgsSymbolList | originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More... | |
bool | renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) override SIP_THROW(QgsCsException) |
Render a feature using this renderer in the given context. More... | |
QgsRuleBasedRenderer::Rule * | rootRule () |
QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) override |
Stores renderer properties to an XML element. More... | |
void | setLegendSymbolItem (const QString &key, QgsSymbol *symbol) override |
Sets the symbol to be used for a legend symbol item. More... | |
void | startRender (QgsRenderContext &context, const QgsFields &fields) override |
Must be called when a new render cycle is started. More... | |
void | stopRender (QgsRenderContext &context) override |
Must be called when a render cycle has finished, to allow the renderer to clean up. More... | |
QgsSymbol * | symbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns symbol for current feature. Should not be used individually: there could be more symbols for a feature. More... | |
QgsSymbolList | symbols (QgsRenderContext &context) const override |
Returns list of symbols used by the renderer. More... | |
QgsSymbolList | symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns list of symbols used for rendering the feature. More... | |
void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const override |
used from subclasses to create SLD Rule elements following SLD v1.1 specs More... | |
QSet< QString > | usedAttributes (const QgsRenderContext &context) const override |
Returns a list of attributes required by this renderer. More... | |
bool | willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const override |
Returns whether the renderer will render a feature or not. More... | |
![]() | |
virtual | ~QgsFeatureRenderer () |
virtual bool | accept (QgsStyleEntityVisitorInterface *visitor) const |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer. More... | |
virtual bool | canSkipRender () |
Returns true if the renderer can be entirely skipped, i.e. More... | |
virtual QgsFeatureRenderer::Capabilities | capabilities () |
Returns details about internals of this renderer. More... | |
virtual void | checkLegendSymbolItem (const QString &key, bool state=true) |
Sets whether the legend symbology item with the specified ley should be checked. More... | |
virtual QgsFeatureRenderer * | clone () const =0 |
Create a deep copy of this renderer. More... | |
void | copyRendererData (QgsFeatureRenderer *destRenderer) const |
Clones generic renderer data to another renderer. More... | |
virtual QString | dump () const |
Returns debug information about this renderer. More... | |
virtual const QgsFeatureRenderer * | embeddedRenderer () const |
Returns the current embedded renderer (subrenderer) for this feature renderer. More... | |
virtual QString | filter (const QgsFields &fields=QgsFields()) |
If a renderer does not require all the features this method may be overridden and return an expression used as where clause. More... | |
virtual bool | filterNeedsGeometry () const |
Returns true if this renderer requires the geometry to apply the filter. More... | |
bool | forceRasterRender () const |
Returns whether the renderer must render as a raster. More... | |
virtual QString | legendClassificationAttribute () const |
If supported by the renderer, return classification attribute for the use in legend. More... | |
QSet< QString > | legendKeys () const |
Returns the set of all legend keys used by the renderer. More... | |
virtual QSet< QString > | legendKeysForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
Returns legend keys matching a specified feature. More... | |
virtual QString | legendKeyToExpression (const QString &key, QgsVectorLayer *layer, bool &ok) const |
Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key. More... | |
virtual bool | legendSymbolItemChecked (const QString &key) |
Returns true if the legend symbology item with the specified key is checked. More... | |
virtual QgsLegendSymbolList | legendSymbolItems () const |
Returns a list of symbology items for the legend. More... | |
virtual bool | legendSymbolItemsCheckable () const |
Returns true if symbology items in legend are checkable. More... | |
virtual void | modifyRequestExtent (QgsRectangle &extent, QgsRenderContext &context) |
Allows for a renderer to modify the extent of a feature request prior to rendering. More... | |
QgsFeatureRequest::OrderBy | orderBy () const |
Gets the order in which features shall be processed by this renderer. More... | |
bool | orderByEnabled () const |
Returns whether custom ordering will be applied before features are processed by this renderer. More... | |
virtual QgsSymbol * | originalSymbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
Returns symbol for feature. More... | |
virtual QgsSymbolList | originalSymbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature() More... | |
QgsPaintEffect * | paintEffect () const |
Returns the current paint effect for the renderer. More... | |
double | referenceScale () const |
Returns the symbology reference scale. More... | |
virtual bool | renderFeature (const QgsFeature &feature, QgsRenderContext &context, int layer=-1, bool selected=false, bool drawVertexMarker=false) SIP_THROW(QgsCsException) |
Render a feature using this renderer in the given context. More... | |
virtual QDomElement | save (QDomDocument &doc, const QgsReadWriteContext &context) |
Stores renderer properties to an XML element. More... | |
virtual void | setEmbeddedRenderer (QgsFeatureRenderer *subRenderer) |
Sets an embedded renderer (subrenderer) for this feature renderer. More... | |
void | setForceRasterRender (bool forceRaster) |
Sets whether the renderer should be rendered to a raster destination. More... | |
virtual void | setLegendSymbolItem (const QString &key, QgsSymbol *symbol) |
Sets the symbol to be used for a legend symbol item. More... | |
void | setOrderBy (const QgsFeatureRequest::OrderBy &orderBy) |
Define the order in which features shall be processed by this renderer. More... | |
void | setOrderByEnabled (bool enabled) |
Sets whether custom ordering should be applied before features are processed by this renderer. More... | |
void | setPaintEffect (QgsPaintEffect *effect) |
Sets the current paint effect for the renderer. More... | |
void | setReferenceScale (double scale) |
Sets the symbology reference scale. More... | |
void | setUsingSymbolLevels (bool usingSymbolLevels) |
void | setVertexMarkerAppearance (Qgis::VertexMarkerType type, double size) |
Sets type and size of editing vertex markers for subsequent rendering. More... | |
virtual void | startRender (QgsRenderContext &context, const QgsFields &fields) |
Must be called when a new render cycle is started. More... | |
virtual void | stopRender (QgsRenderContext &context) |
Must be called when a render cycle has finished, to allow the renderer to clean up. More... | |
virtual QgsSymbol * | symbolForFeature (const QgsFeature &feature, QgsRenderContext &context) const =0 |
To be overridden. More... | |
virtual QgsSymbolList | symbols (QgsRenderContext &context) const |
Returns list of symbols used by the renderer. More... | |
virtual QgsSymbolList | symbolsForFeature (const QgsFeature &feature, QgsRenderContext &context) const |
Returns list of symbols used for rendering the feature. More... | |
virtual void | toSld (QDomDocument &doc, QDomElement &element, const QVariantMap &props=QVariantMap()) const |
used from subclasses to create SLD Rule elements following SLD v1.1 specs More... | |
QString | type () const |
virtual QSet< QString > | usedAttributes (const QgsRenderContext &context) const =0 |
Returns a list of attributes required by this renderer. More... | |
virtual bool | usesEmbeddedSymbols () const |
Returns true if the renderer uses embedded symbols for features. More... | |
bool | usingSymbolLevels () const |
virtual bool | willRenderFeature (const QgsFeature &feature, QgsRenderContext &context) const |
Returns whether the renderer will render a feature or not. More... | |
virtual QDomElement | writeSld (QDomDocument &doc, const QString &styleName, const QVariantMap &props=QVariantMap()) const |
create the SLD UserStyle element following the SLD v1.1 specs with the given name More... | |
Static Public Member Functions | |
static QgsRuleBasedRenderer * | convertFromRenderer (const QgsFeatureRenderer *renderer, QgsVectorLayer *layer=nullptr) |
Creates a new QgsRuleBasedRenderer from an existing renderer. More... | |
static void | convertToDataDefinedSymbology (QgsSymbol *symbol, const QString &sizeScaleField, const QString &rotationField=QString()) |
helper function to convert the size scale and rotation fields present in some other renderers to data defined symbology More... | |
static QgsFeatureRenderer * | create (QDomElement &element, const QgsReadWriteContext &context) |
Creates a new rule-based renderer instance from XML. More... | |
static QgsFeatureRenderer * | createFromSld (QDomElement &element, Qgis::GeometryType geomType) |
Creates a new rule based renderer from an SLD XML element. More... | |
static void | refineRuleCategories (QgsRuleBasedRenderer::Rule *initialRule, QgsCategorizedSymbolRenderer *r) |
take a rule and create a list of new rules based on the categories from categorized symbol renderer More... | |
static void | refineRuleRanges (QgsRuleBasedRenderer::Rule *initialRule, QgsGraduatedSymbolRenderer *r) |
take a rule and create a list of new rules based on the ranges from graduated symbol renderer More... | |
static void | refineRuleScales (QgsRuleBasedRenderer::Rule *initialRule, QList< int > scales) |
take a rule and create a list of new rules with intervals of scales given by the passed scale denominators More... | |
![]() | |
static QgsFeatureRenderer * | defaultRenderer (Qgis::GeometryType geomType) |
Returns a new renderer - used by default in vector layers. More... | |
static QgsFeatureRenderer * | load (QDomElement &symbologyElem, const QgsReadWriteContext &context) |
create a renderer from XML element More... | |
static QgsFeatureRenderer * | loadSld (const QDomNode &node, Qgis::GeometryType geomType, QString &errorMessage) |
Create a new renderer according to the information contained in the UserStyle element of a SLD style document. More... | |
Protected Attributes | |
QList< FeatureToRender > | mCurrentFeatures |
QString | mFilter |
RenderQueue | mRenderQueue |
Rule * | mRootRule = nullptr |
the root node with hierarchical list of rules More... | |
![]() | |
double | mCurrentVertexMarkerSize = 2 |
The current size of editing marker. More... | |
Qgis::VertexMarkerType | mCurrentVertexMarkerType = Qgis::VertexMarkerType::Cross |
The current type of editing marker. More... | |
bool | mForceRaster = false |
QgsFeatureRequest::OrderBy | mOrderBy |
bool | mOrderByEnabled = false |
QgsPaintEffect * | mPaintEffect = nullptr |
double | mReferenceScale = -1.0 |
QString | mType |
bool | mUsingSymbolLevels = false |
Additional Inherited Members | |
![]() | |
QgsFeatureRenderer (const QString &type) | |
void | renderFeatureWithSymbol (const QgsFeature &feature, QgsSymbol *symbol, QgsRenderContext &context, int layer, bool selected, bool drawVertexMarker) SIP_THROW(QgsCsException) |
Render the feature with the symbol using context. More... | |
void | renderVertexMarker (QPointF pt, QgsRenderContext &context) |
render editing vertex marker at specified point More... | |
void | renderVertexMarkerPolygon (QPolygonF &pts, QList< QPolygonF > *rings, QgsRenderContext &context) |
render editing vertex marker for a polygon More... | |
void | renderVertexMarkerPolyline (QPolygonF &pts, QgsRenderContext &context) |
render editing vertex marker for a polyline More... | |
void | saveRendererData (QDomDocument &doc, QDomElement &element, const QgsReadWriteContext &context) |
Saves generic renderer data into the specified element. More... | |
![]() | |
static QPointF | _getPoint (QgsRenderContext &context, const QgsPoint &point) |
Creates a point in screen coordinates from a wkb string in map coordinates. More... | |
static void | convertSymbolRotation (QgsSymbol *symbol, const QString &field) |
static void | convertSymbolSizeScale (QgsSymbol *symbol, Qgis::ScaleMethod method, const QString &field) |
Rule based renderer.
When drawing a vector layer with rule-based renderer, it goes through the rules and draws features with symbols from rules that match.
Definition at line 40 of file qgsrulebasedrenderer.h.
Rendering queue: a list of rendering levels.
Definition at line 134 of file qgsrulebasedrenderer.h.
typedef QList<QgsRuleBasedRenderer::Rule *> QgsRuleBasedRenderer::RuleList |
Definition at line 137 of file qgsrulebasedrenderer.h.
Enumerator | |
---|---|
FeatIsSelected | |
FeatDrawMarkers |
Definition at line 45 of file qgsrulebasedrenderer.h.
QgsRuleBasedRenderer::QgsRuleBasedRenderer | ( | QgsRuleBasedRenderer::Rule * | root | ) |
Constructs the renderer from given tree of rules (takes ownership)
Definition at line 949 of file qgsrulebasedrenderer.cpp.
QgsRuleBasedRenderer::QgsRuleBasedRenderer | ( | QgsSymbol * | defaultSymbol | ) |
Constructor for convenience. Creates a root rule and adds a default rule with symbol (takes ownership)
Definition at line 955 of file qgsrulebasedrenderer.cpp.
|
override |
Definition at line 962 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Accepts the specified symbology visitor, causing it to visit all symbols associated with the renderer.
Returns true
if the visitor should continue visiting other objects, or false
if visiting should be canceled.
Reimplemented from QgsFeatureRenderer.
Definition at line 1417 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns true
if the renderer can be entirely skipped, i.e.
if it is known in advance that no features will be rendered.
Reimplemented from QgsFeatureRenderer.
Definition at line 1016 of file qgsrulebasedrenderer.cpp.
|
inlineoverridevirtual |
Returns details about internals of this renderer.
E.g. if you only want to deal with visible features:
Reimplemented from QgsFeatureRenderer.
Definition at line 555 of file qgsrulebasedrenderer.h.
|
overridevirtual |
Sets whether the legend symbology item with the specified ley should be checked.
Reimplemented from QgsFeatureRenderer.
Definition at line 1144 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Create a deep copy of this renderer.
Should be implemented by all subclasses and generate a proper subclass.
Implements QgsFeatureRenderer.
Definition at line 1084 of file qgsrulebasedrenderer.cpp.
|
static |
Creates a new QgsRuleBasedRenderer from an existing renderer.
Since QGIS 3.20, the optional layer parameter is required for conversions of some renderer types.
nullptr
. Definition at line 1422 of file qgsrulebasedrenderer.cpp.
|
static |
helper function to convert the size scale and rotation fields present in some other renderers to data defined symbology
Definition at line 1654 of file qgsrulebasedrenderer.cpp.
|
static |
Creates a new rule-based renderer instance from XML.
Definition at line 1247 of file qgsrulebasedrenderer.cpp.
|
static |
Creates a new rule based renderer from an SLD XML element.
Definition at line 1270 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns debug information about this renderer.
Reimplemented from QgsFeatureRenderer.
Definition at line 1390 of file qgsrulebasedrenderer.cpp.
If a renderer does not require all the features this method may be overridden and return an expression used as where clause.
This will be called once after startRender() and before the first call to renderFeature(). By default this returns a null string and all features will be requested. You do not need to specify the extent in here, this is taken care of separately and will be combined with a filter returned from this method.
Reimplemented from QgsFeatureRenderer.
Definition at line 1069 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns true
if this renderer requires the geometry to apply the filter.
Reimplemented from QgsFeatureRenderer.
Definition at line 1079 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns legend keys matching a specified feature.
Reimplemented from QgsFeatureRenderer.
Definition at line 1412 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Attempts to convert the specified legend rule key to a QGIS expression matching the features displayed using that key.
key | legend key |
layer | associated vector layer |
ok | will be set to true if legend key was successfully converted to a filter expression |
Reimplemented from QgsFeatureRenderer.
Definition at line 1151 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns true
if the legend symbology item with the specified key is checked.
Reimplemented from QgsFeatureRenderer.
Definition at line 1138 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns a list of symbology items for the legend.
Reimplemented from QgsFeatureRenderer.
Definition at line 1241 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns true
if symbology items in legend are checkable.
Reimplemented from QgsFeatureRenderer.
Definition at line 1133 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Equivalent of originalSymbolsForFeature() call extended to support renderers that may use more symbols per feature - similar to symbolsForFeature()
Reimplemented from QgsFeatureRenderer.
Definition at line 1407 of file qgsrulebasedrenderer.cpp.
|
static |
take a rule and create a list of new rules based on the categories from categorized symbol renderer
Definition at line 1304 of file qgsrulebasedrenderer.cpp.
|
static |
take a rule and create a list of new rules based on the ranges from graduated symbol renderer
Definition at line 1338 of file qgsrulebasedrenderer.cpp.
|
static |
take a rule and create a list of new rules with intervals of scales given by the passed scale denominators
Definition at line 1370 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Render a feature using this renderer in the given context.
Must be called between startRender() and stopRender() calls. Default implementation renders a symbol as determined by symbolForFeature() call. Returns true
if the feature has been returned (this is used for example to determine whether the feature may be labelled).
If layer is not -1, the renderer should draw only a particular layer from symbols (in order to support symbol level rendering).
Reimplemented from QgsFeatureRenderer.
Definition at line 974 of file qgsrulebasedrenderer.cpp.
|
inline |
Definition at line 560 of file qgsrulebasedrenderer.h.
|
overridevirtual |
Stores renderer properties to an XML element.
Subclasses which override this method should call saveRendererData() as part of their implementation in order to store all common base class properties in the returned DOM element.
Reimplemented from QgsFeatureRenderer.
Definition at line 1114 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Sets the symbol to be used for a legend symbol item.
key | rule key for legend symbol |
symbol | new symbol for legend item. Ownership is transferred to renderer. |
Reimplemented from QgsFeatureRenderer.
Definition at line 1232 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Must be called when a new render cycle is started.
A call to startRender() must always be followed by a corresponding call to stopRender() after all features have been rendered.
context | Additional information passed to the renderer about the job which will be rendered |
fields | The fields available for rendering |
Reimplemented from QgsFeatureRenderer.
Definition at line 990 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Must be called when a render cycle has finished, to allow the renderer to clean up.
Calls to stopRender() must always be preceded by a call to startRender().
Reimplemented from QgsFeatureRenderer.
Definition at line 1021 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns symbol for current feature. Should not be used individually: there could be more symbols for a feature.
Implements QgsFeatureRenderer.
Definition at line 968 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns list of symbols used by the renderer.
context | render context |
Reimplemented from QgsFeatureRenderer.
Definition at line 1109 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns list of symbols used for rendering the feature.
For renderers that do not support MoreSymbolsPerFeature it is more efficient to use symbolForFeature()
Reimplemented from QgsFeatureRenderer.
Definition at line 1402 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
used from subclasses to create SLD Rule elements following SLD v1.1 specs
Reimplemented from QgsFeatureRenderer.
Definition at line 1103 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns a list of attributes required by this renderer.
Attributes not listed in here may not have been requested from the provider at rendering time.
Implements QgsFeatureRenderer.
Definition at line 1074 of file qgsrulebasedrenderer.cpp.
|
overridevirtual |
Returns whether the renderer will render a feature or not.
Must be called between startRender() and stopRender() calls. Default implementation uses symbolForFeature().
Reimplemented from QgsFeatureRenderer.
Definition at line 1397 of file qgsrulebasedrenderer.cpp.
|
protected |
Definition at line 590 of file qgsrulebasedrenderer.h.
|
protected |
Definition at line 592 of file qgsrulebasedrenderer.h.
|
protected |
Definition at line 589 of file qgsrulebasedrenderer.h.
|
protected |
the root node with hierarchical list of rules
Definition at line 586 of file qgsrulebasedrenderer.h.