QGIS API Documentation  3.14.0-Pi (9f7028fd23)
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 
26 
28 typedef QMap<QString, QVector<QgsFeature> > QgsVectorTileFeatures SIP_SKIP;
29 
37 class CORE_EXPORT QgsVectorTileRendererData
38 {
39  public:
41  explicit QgsVectorTileRendererData( QgsTileXYZ id ): mId( id ) {}
42 
44  QgsTileXYZ id() const { return mId; }
45 
47  void setTilePolygon( QPolygon polygon ) { mTilePolygon = polygon; }
49  QPolygon tilePolygon() const { return mTilePolygon; }
50 
52  void setFields( const QMap<QString, QgsFields> &fields ) { mFields = fields; }
54  QMap<QString, QgsFields> fields() const { return mFields; }
55 
57  void setFeatures( const QgsVectorTileFeatures &features ) SIP_SKIP { mFeatures = features; }
59  QgsVectorTileFeatures features() const SIP_SKIP { return mFeatures; }
61  QStringList layers() const { return mFeatures.keys(); }
63  QVector<QgsFeature> layerFeatures( const QString &layerName ) const { return mFeatures[layerName]; }
64 
65  private:
67  QgsTileXYZ mId;
69  QMap<QString, QgsFields> mFields;
71  QgsVectorTileFeatures mFeatures;
73  QPolygon mTilePolygon;
74 };
75 
88 class CORE_EXPORT QgsVectorTileRenderer
89 {
90 
91 #ifdef SIP_RUN
93 
94  const QString type = sipCpp->type();
95 
96  if ( type == QStringLiteral( "basic" ) )
97  sipType = sipType_QgsVectorTileBasicRenderer;
98  else
99  sipType = 0;
100  SIP_END
101 #endif
102 
103  public:
104  virtual ~QgsVectorTileRenderer() = default;
105 
107  virtual QString type() const = 0;
108 
110  virtual QgsVectorTileRenderer *clone() const = 0 SIP_FACTORY;
111 
113  virtual void startRender( QgsRenderContext &context, int tileZoom, const QgsTileRange &tileRange ) = 0;
114 
116  virtual QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext & ) SIP_SKIP { return QMap<QString, QSet<QString> >(); }
117 
119  virtual void stopRender( QgsRenderContext &context ) = 0;
120 
122  virtual void renderTile( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) = 0;
123 
125  virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
127  virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
129  virtual void resolveReferences( const QgsProject &project ) { Q_UNUSED( project ) }
130 
131 };
132 
133 #endif // QGSVECTORTILERENDERER_H
QgsTileXYZ
Definition: qgstiles.h:32
QgsReadWriteContext
Definition: qgsreadwritecontext.h:34
QgsVectorTileRendererData::setFields
void setFields(const QMap< QString, QgsFields > &fields)
Sets per-layer fields.
Definition: qgsvectortilerenderer.h:52
QgsTileRange
Definition: qgstiles.h:65
qgsfeature.h
QgsRenderContext
Definition: qgsrendercontext.h:57
QgsVectorTileRendererData
Definition: qgsvectortilerenderer.h:37
QgsVectorTileRendererData::tilePolygon
QPolygon tilePolygon() const
Returns polygon (made out of four corners of the tile) in screen coordinates calculated from render c...
Definition: qgsvectortilerenderer.h:49
QgsProject
Definition: qgsproject.h:92
QgsVectorTileRendererData::id
QgsTileXYZ id() const
Returns coordinates of the tile.
Definition: qgsvectortilerenderer.h:44
SIP_FACTORY
#define SIP_FACTORY
Definition: qgis_sip.h:76
QgsVectorTileRendererData::QgsVectorTileRendererData
QgsVectorTileRendererData(QgsTileXYZ id)
Constructs the object.
Definition: qgsvectortilerenderer.h:41
SIP_CONVERT_TO_SUBCLASS_CODE
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:172
QgsVectorTileRendererData::fields
QMap< QString, QgsFields > fields() const
Returns per-layer fields.
Definition: qgsvectortilerenderer.h:54
SIP_SKIP
#define SIP_SKIP
Definition: qgis_sip.h:126
QgsVectorTileRenderer
Definition: qgsvectortilerenderer.h:88
QgsVectorTileRendererData::setFeatures
void setFeatures(const QgsVectorTileFeatures &features)
Sets features of the tile.
Definition: qgsvectortilerenderer.h:57
QgsVectorTileRenderer::usedAttributes
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...
Definition: qgsvectortilerenderer.h:116
QgsVectorTileRendererData::setTilePolygon
void setTilePolygon(QPolygon polygon)
Sets polygon of the tile.
Definition: qgsvectortilerenderer.h:47
qgstiles.h
QgsVectorTileRendererData::layers
QStringList layers() const
Returns list of layer names present in the tile.
Definition: qgsvectortilerenderer.h:61
QgsVectorTileRendererData::layerFeatures
QVector< QgsFeature > layerFeatures(const QString &layerName) const
Returns list of all features within a single sub-layer.
Definition: qgsvectortilerenderer.h:63
QgsVectorTileRendererData::features
QgsVectorTileFeatures features() const
Returns features of the tile grouped by sub-layer names.
Definition: qgsvectortilerenderer.h:59
QgsVectorTileFeatures
QMap< QString, QVector< QgsFeature > > QgsVectorTileFeatures
Features of a vector tile, grouped by sub-layer names (key of the map)
Definition: qgsvectortilerenderer.h:25
SIP_END
#define SIP_END
Definition: qgis_sip.h:189
QgsVectorTileRenderer::resolveReferences
virtual void resolveReferences(const QgsProject &project)
Resolves references to other objects - second phase of loading - after readXml()
Definition: qgsvectortilerenderer.h:129