QGIS API Documentation 3.40.0-Bratislava (b56115d8743)
|
Abstract base class for all vector tile renderer implementations. More...
#include <qgsvectortilerenderer.h>
Public Member Functions | |
virtual | ~QgsVectorTileRenderer ()=default |
virtual QgsVectorTileRenderer * | clone () const =0 |
Returns a clone of the renderer. | |
virtual void | readXml (const QDomElement &elem, const QgsReadWriteContext &context)=0 |
Reads renderer's properties from given XML element. | |
virtual void | renderBackground (QgsRenderContext &context)=0 |
Renders the background if defined. | |
virtual void | renderSelectedFeatures (const QList< QgsFeature > &selection, QgsRenderContext &context)=0 |
Renders the specified features in a selected state. | |
virtual void | renderTile (const QgsVectorTileRendererData &tile, QgsRenderContext &context)=0 |
Renders given vector tile. Must be called between startRender/stopRender. | |
virtual QSet< QString > | requiredLayers (QgsRenderContext &context, int tileZoom) const |
Returns a list of the layers required for rendering. | |
virtual void | resolveReferences (const QgsProject &project) |
Resolves references to other objects - second phase of loading - after readXml() | |
virtual void | startRender (QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange)=0 |
Initializes rendering. It should be paired with a stopRender() call. | |
virtual void | stopRender (QgsRenderContext &context)=0 |
Finishes rendering and cleans up any resources. | |
virtual QString | type () const =0 |
Returns unique type name of the renderer implementation. | |
virtual QMap< QString, QSet< QString > > | usedAttributes (const QgsRenderContext &) |
Returns field names of sub-layers that will be used for rendering. Must be called between startRender/stopRender. | |
virtual bool | willRenderFeature (const QgsFeature &feature, int tileZoom, const QString &layerName, QgsRenderContext &context)=0 |
Returns true if the specified feature will be rendered in the given render context. | |
virtual void | writeXml (QDomElement &elem, const QgsReadWriteContext &context) const =0 |
Writes renderer's properties to given XML element. | |
Abstract base class for all vector tile renderer implementations.
For rendering it is expected that client code calls:
Definition at line 122 of file qgsvectortilerenderer.h.
|
virtualdefault |
|
pure virtual |
Returns a clone of the renderer.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Reads renderer's properties from given XML element.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Renders the background if defined.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Renders the specified features in a selected state.
This will be called after rendering the tiles, so that the selected features are always visible on the top of the layer.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Renders given vector tile. Must be called between startRender/stopRender.
Implemented in QgsVectorTileBasicRenderer.
|
inlinevirtual |
Returns a list of the layers required for rendering.
Only layers which are visible at the specified tileZoom should be included in this list.
An empty string present in the list indicates that all layer in the tiles are required.
Reimplemented in QgsVectorTileBasicRenderer.
Definition at line 163 of file qgsvectortilerenderer.h.
|
inlinevirtual |
Resolves references to other objects - second phase of loading - after readXml()
Definition at line 195 of file qgsvectortilerenderer.h.
|
pure virtual |
Initializes rendering. It should be paired with a stopRender() call.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Finishes rendering and cleans up any resources.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Returns unique type name of the renderer implementation.
Implemented in QgsVectorTileBasicRenderer.
|
inlinevirtual |
Returns field names of sub-layers that will be used for rendering. Must be called between startRender/stopRender.
Reimplemented in QgsVectorTileBasicRenderer.
Definition at line 150 of file qgsvectortilerenderer.h.
|
pure virtual |
Returns true
if the specified feature will be rendered in the given render context.
Implemented in QgsVectorTileBasicRenderer.
|
pure virtual |
Writes renderer's properties to given XML element.
Implemented in QgsVectorTileBasicRenderer.