QGIS API Documentation 3.39.0-Master (bca3cdb6021)
|
The default vector tile renderer implementation. More...
#include <qgsvectortilebasicrenderer.h>
Public Member Functions | |
QgsVectorTileBasicRenderer () | |
Constructs renderer with no styles. | |
QgsVectorTileBasicRenderer * | clone () const override |
Returns a clone of the renderer. | |
void | readXml (const QDomElement &elem, const QgsReadWriteContext &context) override |
Reads renderer's properties from given XML element. | |
void | renderBackground (QgsRenderContext &context) override |
Renders the background if defined. | |
void | renderSelectedFeatures (const QList< QgsFeature > &selection, QgsRenderContext &context) override |
Renders the specified features in a selected state. | |
void | renderTile (const QgsVectorTileRendererData &tile, QgsRenderContext &context) override |
Renders given vector tile. Must be called between startRender/stopRender. | |
QSet< QString > | requiredLayers (QgsRenderContext &context, int tileZoom) const override |
Returns a list of the layers required for rendering. | |
void | setStyle (int index, const QgsVectorTileBasicRendererStyle &style) |
Updates style definition at the paricular index of the list (the index must be in interval [0,N-1] otherwise this function does nothing) | |
void | setStyles (const QList< QgsVectorTileBasicRendererStyle > &styles) |
Sets list of styles of the renderer. | |
void | startRender (QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange) override |
Initializes rendering. It should be paired with a stopRender() call. | |
void | stopRender (QgsRenderContext &context) override |
Finishes rendering and cleans up any resources. | |
QgsVectorTileBasicRendererStyle | style (int index) const |
Returns style definition at the particular index. | |
QList< QgsVectorTileBasicRendererStyle > | styles () const |
Returns list of styles of the renderer. | |
QString | type () const override |
Returns unique type name of the renderer implementation. | |
QMap< QString, QSet< QString > > | usedAttributes (const QgsRenderContext &) override |
Returns field names of sub-layers that will be used for rendering. Must be called between startRender/stopRender. | |
bool | willRenderFeature (const QgsFeature &feature, int tileZoom, const QString &layerName, QgsRenderContext &context) override |
Returns true if the specified feature will be rendered in the given render context. | |
void | writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override |
Writes renderer's properties to given XML element. | |
Public Member Functions inherited from QgsVectorTileRenderer | |
virtual | ~QgsVectorTileRenderer ()=default |
virtual void | resolveReferences (const QgsProject &project) |
Resolves references to other objects - second phase of loading - after readXml() | |
Static Public Member Functions | |
static QList< QgsVectorTileBasicRendererStyle > | simpleStyle (const QColor &polygonFillColor, const QColor &polygonStrokeColor, double polygonStrokeWidth, const QColor &lineStrokeColor, double lineStrokeWidth, const QColor &pointFillColor, const QColor &pointStrokeColor, double pointSize) |
Returns a list of styles to render all layers with the given fill/stroke colors, stroke widths and marker sizes. | |
static QList< QgsVectorTileBasicRendererStyle > | simpleStyleWithRandomColors () |
Returns a list of styles to render all layers, using random colors. | |
The default vector tile renderer implementation.
It has an ordered list of "styles", each defines a rendering rule.
Definition at line 169 of file qgsvectortilebasicrenderer.h.
QgsVectorTileBasicRenderer::QgsVectorTileBasicRenderer | ( | ) |
Constructs renderer with no styles.
Definition at line 103 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Returns a clone of the renderer.
Implements QgsVectorTileRenderer.
Definition at line 112 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Reads renderer's properties from given XML element.
Implements QgsVectorTileRenderer.
Definition at line 411 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Renders the background if defined.
Implements QgsVectorTileRenderer.
Definition at line 165 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
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.
Implements QgsVectorTileRenderer.
Definition at line 285 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Renders given vector tile. Must be called between startRender/stopRender.
Implements QgsVectorTileRenderer.
Definition at line 193 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
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 from QgsVectorTileRenderer.
Definition at line 147 of file qgsvectortilebasicrenderer.cpp.
|
inline |
Updates style definition at the paricular index of the list (the index must be in interval [0,N-1] otherwise this function does nothing)
Definition at line 193 of file qgsvectortilebasicrenderer.h.
void QgsVectorTileBasicRenderer::setStyles | ( | const QList< QgsVectorTileBasicRendererStyle > & | styles | ) |
Sets list of styles of the renderer.
Definition at line 426 of file qgsvectortilebasicrenderer.cpp.
|
static |
Returns a list of styles to render all layers with the given fill/stroke colors, stroke widths and marker sizes.
Definition at line 456 of file qgsvectortilebasicrenderer.cpp.
|
static |
Returns a list of styles to render all layers, using random colors.
Definition at line 436 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Initializes rendering. It should be paired with a stopRender() call.
Implements QgsVectorTileRenderer.
Definition at line 120 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Finishes rendering and cleans up any resources.
Implements QgsVectorTileRenderer.
Definition at line 160 of file qgsvectortilebasicrenderer.cpp.
|
inline |
Returns style definition at the particular index.
Definition at line 195 of file qgsvectortilebasicrenderer.h.
QList< QgsVectorTileBasicRendererStyle > QgsVectorTileBasicRenderer::styles | ( | ) | const |
Returns list of styles of the renderer.
Definition at line 431 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Returns unique type name of the renderer implementation.
Implements QgsVectorTileRenderer.
Definition at line 107 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Returns field names of sub-layers that will be used for rendering. Must be called between startRender/stopRender.
Reimplemented from QgsVectorTileRenderer.
Definition at line 142 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Returns true
if the specified feature will be rendered in the given render context.
Implements QgsVectorTileRenderer.
Definition at line 353 of file qgsvectortilebasicrenderer.cpp.
|
overridevirtual |
Writes renderer's properties to given XML element.
Implements QgsVectorTileRenderer.
Definition at line 398 of file qgsvectortilebasicrenderer.cpp.