QGIS API Documentation  3.21.0-Master (564c892cfd)
Public Member Functions | Static Public Member Functions | List of all members
QgsVectorTileBasicRenderer Class Reference

The default vector tile renderer implementation. More...

#include <qgsvectortilebasicrenderer.h>

Inheritance diagram for QgsVectorTileBasicRenderer:
Inheritance graph
[legend]

Public Member Functions

 QgsVectorTileBasicRenderer ()
 Constructs renderer with no styles. More...
 
QgsVectorTileBasicRendererclone () const override
 Returns a clone of the renderer. More...
 
void readXml (const QDomElement &elem, const QgsReadWriteContext &context) override
 Reads renderer's properties from given XML element. More...
 
void renderTile (const QgsVectorTileRendererData &tile, QgsRenderContext &context) override
 Renders given vector tile. Must be called between startRender/stopRender. More...
 
QSet< QString > requiredLayers (QgsRenderContext &context, int tileZoom) const override
 Returns a list of the layers required for rendering. More...
 
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) More...
 
void setStyles (const QList< QgsVectorTileBasicRendererStyle > &styles)
 Sets list of styles of the renderer. More...
 
void startRender (QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange) override
 Initializes rendering. It should be paired with a stopRender() call. More...
 
void stopRender (QgsRenderContext &context) override
 Finishes rendering and cleans up any resources. More...
 
QgsVectorTileBasicRendererStyle style (int index) const
 Returns style definition at the particular index. More...
 
QList< QgsVectorTileBasicRendererStylestyles () const
 Returns list of styles of the renderer. More...
 
QString type () const override
 Returns unique type name of the renderer implementation. More...
 
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. More...
 
void writeXml (QDomElement &elem, const QgsReadWriteContext &context) const override
 Writes renderer's properties to given XML element. More...
 
- 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() More...
 

Static Public Member Functions

static QList< QgsVectorTileBasicRendererStylesimpleStyle (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. More...
 
static QList< QgsVectorTileBasicRendererStylesimpleStyleWithRandomColors ()
 Returns a list of styles to render all layers, using random colors. More...
 

Detailed Description

The default vector tile renderer implementation.

It has an ordered list of "styles", each defines a rendering rule.

Since
QGIS 3.14

Definition at line 127 of file qgsvectortilebasicrenderer.h.

Constructor & Destructor Documentation

◆ QgsVectorTileBasicRenderer()

QgsVectorTileBasicRenderer::QgsVectorTileBasicRenderer ( )

Constructs renderer with no styles.

Definition at line 104 of file qgsvectortilebasicrenderer.cpp.

Member Function Documentation

◆ clone()

QgsVectorTileBasicRenderer * QgsVectorTileBasicRenderer::clone ( ) const
overridevirtual

Returns a clone of the renderer.

Implements QgsVectorTileRenderer.

Definition at line 113 of file qgsvectortilebasicrenderer.cpp.

◆ readXml()

void QgsVectorTileBasicRenderer::readXml ( const QDomElement &  elem,
const QgsReadWriteContext context 
)
overridevirtual

Reads renderer's properties from given XML element.

Implements QgsVectorTileRenderer.

Definition at line 253 of file qgsvectortilebasicrenderer.cpp.

◆ renderTile()

void QgsVectorTileBasicRenderer::renderTile ( const QgsVectorTileRendererData tile,
QgsRenderContext context 
)
overridevirtual

Renders given vector tile. Must be called between startRender/stopRender.

Implements QgsVectorTileRenderer.

Definition at line 166 of file qgsvectortilebasicrenderer.cpp.

◆ requiredLayers()

QSet< QString > QgsVectorTileBasicRenderer::requiredLayers ( QgsRenderContext context,
int  tileZoom 
) const
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.

Since
QGIS 3.16

Reimplemented from QgsVectorTileRenderer.

Definition at line 148 of file qgsvectortilebasicrenderer.cpp.

◆ setStyle()

void QgsVectorTileBasicRenderer::setStyle ( int  index,
const QgsVectorTileBasicRendererStyle style 
)
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 148 of file qgsvectortilebasicrenderer.h.

◆ setStyles()

void QgsVectorTileBasicRenderer::setStyles ( const QList< QgsVectorTileBasicRendererStyle > &  styles)

Sets list of styles of the renderer.

Definition at line 268 of file qgsvectortilebasicrenderer.cpp.

◆ simpleStyle()

QList< QgsVectorTileBasicRendererStyle > QgsVectorTileBasicRenderer::simpleStyle ( const QColor &  polygonFillColor,
const QColor &  polygonStrokeColor,
double  polygonStrokeWidth,
const QColor &  lineStrokeColor,
double  lineStrokeWidth,
const QColor &  pointFillColor,
const QColor &  pointStrokeColor,
double  pointSize 
)
static

Returns a list of styles to render all layers with the given fill/stroke colors, stroke widths and marker sizes.

Definition at line 298 of file qgsvectortilebasicrenderer.cpp.

◆ simpleStyleWithRandomColors()

QList< QgsVectorTileBasicRendererStyle > QgsVectorTileBasicRenderer::simpleStyleWithRandomColors ( )
static

Returns a list of styles to render all layers, using random colors.

Definition at line 278 of file qgsvectortilebasicrenderer.cpp.

◆ startRender()

void QgsVectorTileBasicRenderer::startRender ( QgsRenderContext context,
int  tileZoom,
const QgsTileRange tileRange 
)
overridevirtual

Initializes rendering. It should be paired with a stopRender() call.

Implements QgsVectorTileRenderer.

Definition at line 121 of file qgsvectortilebasicrenderer.cpp.

◆ stopRender()

void QgsVectorTileBasicRenderer::stopRender ( QgsRenderContext context)
overridevirtual

Finishes rendering and cleans up any resources.

Implements QgsVectorTileRenderer.

Definition at line 161 of file qgsvectortilebasicrenderer.cpp.

◆ style()

QgsVectorTileBasicRendererStyle QgsVectorTileBasicRenderer::style ( int  index) const
inline

Returns style definition at the particular index.

Definition at line 150 of file qgsvectortilebasicrenderer.h.

◆ styles()

QList< QgsVectorTileBasicRendererStyle > QgsVectorTileBasicRenderer::styles ( ) const

Returns list of styles of the renderer.

Definition at line 273 of file qgsvectortilebasicrenderer.cpp.

◆ type()

QString QgsVectorTileBasicRenderer::type ( ) const
overridevirtual

Returns unique type name of the renderer implementation.

Implements QgsVectorTileRenderer.

Definition at line 108 of file qgsvectortilebasicrenderer.cpp.

◆ usedAttributes()

QMap< QString, QSet< QString > > QgsVectorTileBasicRenderer::usedAttributes ( const QgsRenderContext )
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 143 of file qgsvectortilebasicrenderer.cpp.

◆ writeXml()

void QgsVectorTileBasicRenderer::writeXml ( QDomElement &  elem,
const QgsReadWriteContext context 
) const
overridevirtual

Writes renderer's properties to given XML element.

Implements QgsVectorTileRenderer.

Definition at line 240 of file qgsvectortilebasicrenderer.cpp.


The documentation for this class was generated from the following files: