QGIS API Documentation  3.19.0-Master (c022ae99b5)
qgsvectortilelabeling.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsvectortilelabeling.h
3  --------------------------------------
4  Date : April 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 QGSVECTORTILELABELING_H
17 #define QGSVECTORTILELABELING_H
18 
19 #include "qgis_core.h"
20 
22 
23 class QgsVectorTileLayer;
25 
26 #ifndef SIP_RUN
27 
34 {
35  public:
38 
40  virtual QMap<QString, QSet<QString> > usedAttributes( const QgsRenderContext &context, int tileZoom ) const = 0;
41 
42  //TODO QGIS 4.0 -- make pure virtual
43 
53  virtual QSet< QString > requiredLayers( QgsRenderContext &context, int tileZoom ) const { Q_UNUSED( context ); Q_UNUSED( tileZoom ); return QSet< QString >() << QString(); }
54 
56  virtual void setFields( const QMap<QString, QgsFields> &perLayerFields ) = 0;
57 
59  virtual void registerTileFeatures( const QgsVectorTileRendererData &tile, QgsRenderContext &context ) = 0;
60 };
61 
62 #endif
63 
70 class CORE_EXPORT QgsVectorTileLabeling
71 {
72 
73 #ifdef SIP_RUN
75 
76  const QString type = sipCpp->type();
77 
78  if ( type == QLatin1String( "basic" ) )
79  sipType = sipType_QgsVectorTileBasicLabeling;
80  else
81  sipType = 0;
82  SIP_END
83 #endif
84 
85  public:
86  virtual ~QgsVectorTileLabeling() = default;
87 
89  virtual QString type() const = 0;
90 
92  virtual QgsVectorTileLabeling *clone() const = 0 SIP_FACTORY;
93 
98  virtual QgsVectorTileLabelProvider *provider( QgsVectorTileLayer *layer ) const SIP_SKIP { Q_UNUSED( layer ) return nullptr; }
99 
101  virtual void writeXml( QDomElement &elem, const QgsReadWriteContext &context ) const = 0;
103  virtual void readXml( const QDomElement &elem, const QgsReadWriteContext &context ) = 0;
105  virtual void resolveReferences( const QgsProject &project ) { Q_UNUSED( project ) }
106 
107 };
108 
109 #endif // QGSVECTORTILELABELING_H
QgsMapLayer * layer() const
Returns the associated layer, or nullptr if no layer is associated with the provider.
Encapsulates a QGIS project, including sets of map layers and their styles, layouts,...
Definition: qgsproject.h:99
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.
The QgsVectorLayerLabelProvider class implements a label provider for vector layers.
Internal base class for implementation of label providers for vector tile labeling.
virtual void setFields(const QMap< QString, QgsFields > &perLayerFields)=0
Sets fields for each sub-layer.
virtual QSet< QString > requiredLayers(QgsRenderContext &context, int tileZoom) const
Returns a list of the layers required for labeling.
virtual QMap< QString, QSet< QString > > usedAttributes(const QgsRenderContext &context, int tileZoom) const =0
Returns field names for each sub-layer that are required for labeling.
virtual void registerTileFeatures(const QgsVectorTileRendererData &tile, QgsRenderContext &context)=0
Registers label features for given tile to the labeling engine.
QgsVectorTileLabelProvider(QgsVectorTileLayer *layer)
Constructs base label provider class for the given vector tile layer.
Base class for labeling configuration classes for vector tile layers.
virtual QgsVectorTileLabelProvider * provider(QgsVectorTileLayer *layer) const SIP_SKIP
Factory for label provider implementation.
virtual ~QgsVectorTileLabeling()=default
virtual QString type() const =0
Unique type string of the labeling configuration implementation.
virtual void readXml(const QDomElement &elem, const QgsReadWriteContext &context)=0
Reads labeling properties from given XML element.
virtual QgsVectorTileLabeling * clone() const =0SIP_FACTORY
Returns a new copy of the object.
virtual void writeXml(QDomElement &elem, const QgsReadWriteContext &context) const =0
Writes labeling properties to given XML element.
virtual void resolveReferences(const QgsProject &project)
Resolves references to other objects - second phase of loading - after readXml()
Implements a map layer that is dedicated to rendering of vector tiles.
Contains decoded features of a single vector tile and any other data necessary for rendering of it.
#define SIP_CONVERT_TO_SUBCLASS_CODE(code)
Definition: qgis_sip.h:177
#define SIP_SKIP
Definition: qgis_sip.h:126
#define SIP_FACTORY
Definition: qgis_sip.h:76
#define SIP_END
Definition: qgis_sip.h:194