QGIS API Documentation 3.35.0-Master (f6e073f0eed)
Loading...
Searching...
No Matches
qgsvectortilerenderer.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsvectortilerenderer.h
3 --------------------------------------
4 Date : March 2020
5 Copyright : (C) 2020 by Martin Dobias
6 Email : wonder dot sk at gmail dot com
7 ***************************************************************************
8 * *
9 * This program is free software; you can redistribute it and/or modify *
10 * it under the terms of the GNU General Public License as published by *
11 * the Free Software Foundation; either version 2 of the License, or *
12 * (at your option) any later version. *
13 * *
14 ***************************************************************************/
15
16#ifndef QGSVECTORTILERENDERER_H
17#define QGSVECTORTILERENDERER_H
18
19#include "qgis_core.h"
20
21#include "qgsfeature.h"
22
23#include "qgstiles.h"
24
27class QgsProject;
28
30typedef QMap<QString, QVector<QgsFeature> > QgsVectorTileFeatures SIP_SKIP;
31
40{
41 public:
44 : mId( id )
45 , mRenderZoomLevel( id.zoomLevel() )
46 {}
47
49 QgsTileXYZ id() const { return mId; }
50
52 void setTilePolygon( QPolygon polygon ) { mTilePolygon = polygon; }
54 QPolygon tilePolygon() const { return mTilePolygon; }
55
65 void setRenderZoomLevel( int level ) { mRenderZoomLevel = level; }
66
76 int renderZoomLevel() const { return mRenderZoomLevel; }
77
79 void setFields( const QMap<QString, QgsFields> &fields ) { mFields = fields; }
81 QMap<QString, QgsFields> fields() const { return mFields; }
82
84 void setFeatures( const QgsVectorTileFeatures &features ) SIP_SKIP { mFeatures = features; }
86 QgsVectorTileFeatures features() const SIP_SKIP { return mFeatures; }
88 QStringList layers() const { return mFeatures.keys(); }
90 QVector<QgsFeature> layerFeatures( const QString &layerName ) const { return mFeatures[layerName]; }
91
92 private:
94 QgsTileXYZ mId;
95
100 int mRenderZoomLevel = -1;
101
103 QMap<QString, QgsFields> mFields;
105 QgsVectorTileFeatures mFeatures;
107 QPolygon mTilePolygon;
108};
109
122class CORE_EXPORT QgsVectorTileRenderer
123{
124
125#ifdef SIP_RUN
127
128 const QString type = sipCpp->type();
129
130 if ( type == QLatin1String( "basic" ) )
131 sipType = sipType_QgsVectorTileBasicRenderer;
132 else
133 sipType = 0;
134 SIP_END
135#endif
136
137 public:
138 virtual ~QgsVectorTileRenderer() = default;
139
141 virtual QString type() const = 0;
142
145
147 virtual void startRender( QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange ) = 0;
148
150 virtual QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext & ) SIP_SKIP { return QMap<QString, QSet<QString> >(); }
151
152 //TODO QGIS 4.0 -- make pure virtual
153
163 virtual QSet< QString > requiredLayers( QgsRenderContext &context, int tileZoom ) const { Q_UNUSED( context ); Q_UNUSED( tileZoom ); return QSet< QString >() << QString(); }
164
166 virtual void stopRender( QgsRenderContext &context ) = 0;
167
169 virtual void renderBackground( QgsRenderContext &context ) = 0;
170
172 virtual void renderTile( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) = 0;
173
179 virtual bool willRenderFeature( const QgsFeature &feature, int tileZoom, const QString &layerName, QgsRenderContext &context ) = 0;
180
188 virtual void renderSelectedFeatures( const QList< QgsFeature > &selection, QgsRenderContext &context ) = 0;
189
191 virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
193 virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
195 virtual void resolveReferences( const QgsProject &project ) { Q_UNUSED( project ) }
196
197};
198
199#endif // QGSVECTORTILERENDERER_H
The feature class encapsulates a single feature including its unique ID, geometry and a list of field...
Definition qgsfeature.h:56
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition qgsproject.h:107
The class is used as a container of context for various read/write operations on other objects.
Contains information about the context of a rendering operation.
Range of tiles in a tile matrix to be rendered.
Definition qgstiles.h:97
Stores coordinates of a tile in a tile matrix set.
Definition qgstiles.h:38
Contains decoded features of a single vector tile and any other data necessary for rendering of it.
void setFields(const QMap< QString, QgsFields > &fields)
Sets per-layer fields.
QPolygon tilePolygon() const
Returns polygon (made out of four corners of the tile) in screen coordinates calculated from render c...
QgsVectorTileRendererData(QgsTileXYZ id)
Constructs the object.
QMap< QString, QgsFields > fields() const
Returns per-layer fields.
void setTilePolygon(QPolygon polygon)
Sets polygon of the tile.
QgsVectorTileFeatures features() const
Returns features of the tile grouped by sub-layer names.
void setRenderZoomLevel(int level)
Sets the zoom level corresponding to the target render.
QVector< QgsFeature > layerFeatures(const QString &layerName) const
Returns list of all features within a single sub-layer.
int renderZoomLevel() const
Returns the zoom level corresponding to the target render.
QStringList layers() const
Returns list of layer names present in the tile.
void setFeatures(const QgsVectorTileFeatures &features)
Sets features of the tile.
QgsTileXYZ id() const
Returns coordinates of the tile.
Abstract base class for all vector tile renderer implementations.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)=0
Reads renderer's properties from given XML element.
virtual void resolveReferences(const QgsProject &project)
Resolves references to other objects - second phase of loading - after readXml()
virtual void renderSelectedFeatures(const QList< QgsFeature > &selection, QgsRenderContext &context)=0
Renders the specified features in a selected state.
virtual QSet< QString > requiredLayers(QgsRenderContext &context, int tileZoom) const
Returns a list of the layers required for rendering.
virtual void renderBackground(QgsRenderContext &context)=0
Renders the background if defined.
virtual QString type() const =0
Returns unique type name of the renderer implementation.
virtual void writeXml(QDomElement &elem, const QgsReadWriteContext &context) const =0
Writes renderer's properties to given XML element.
virtual void renderTile(const QgsVectorTileRendererData &tile, QgsRenderContext &context)=0
Renders given vector tile. Must be called between startRender/stopRender.
virtual QgsVectorTileRenderer * clone() const =0
Returns a clone of the renderer.
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...
virtual void stopRender(QgsRenderContext &context)=0
Finishes rendering and cleans up any resources.
virtual ~QgsVectorTileRenderer()=default
virtual void startRender(QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange)=0
Initializes rendering. It should be paired with a stopRender() call.
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.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition qgis_sip.h:191
#define SIP_SKIP
Definition qgis_sip.h:126
#define SIP_FACTORY
Definition qgis_sip.h:76
#define SIP_END
Definition qgis_sip.h:208
QMap< QString, QVector< QgsFeature > > QgsVectorTileFeatures
Features of a vector tile, grouped by sub-layer names (key of the map)