QGIS API Documentation 3.31.0-Master (9f23a2c1dc)
qgsxyzvectortiledataprovider.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsxyzvectortiledataprovider.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 QGSXYZVECTORTILEDATAPROVIDER_H
17#define QGSXYZVECTORTILEDATAPROVIDER_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
22#include "qgsprovidermetadata.h"
24
25#define SIP_NO_FILE
26
28
29class CORE_EXPORT QgsXyzVectorTileDataProviderBase : public QgsVectorTileDataProvider
30{
31 Q_OBJECT
32
33 public:
34 QgsXyzVectorTileDataProviderBase( const QString &uri,
35 const QgsDataProvider::ProviderOptions &providerOptions,
36 QgsDataProvider::ReadFlags flags );
37 QgsXyzVectorTileDataProviderBase( const QgsXyzVectorTileDataProviderBase &other );
38
42 QgsXyzVectorTileDataProviderBase &operator=( const QgsXyzVectorTileDataProviderBase &other ) = delete;
43
44 bool supportsAsync() const override;
45 QgsVectorTileRawData readTile( const QgsTileMatrixSet &tileMatrix, const QgsTileXYZ &id, QgsFeedback *feedback = nullptr ) const override;
46 QList<QgsVectorTileRawData> readTiles( const QgsTileMatrixSet &, const QVector<QgsTileXYZ> &tiles, QgsFeedback *feedback = nullptr ) const override;
47 QNetworkRequest tileRequest( const QgsTileMatrixSet &tileMatrix, const QgsTileXYZ &id, Qgis::RendererUsage usage ) const override;
48
49 protected:
50
51 QString mAuthCfg;
52 QgsHttpHeaders mHeaders;
53
54 private:
55
57 static QByteArray loadFromNetwork( const QgsTileXYZ &id,
58 const QgsTileMatrix &tileMatrix,
59 const QString &requestUrl,
60 const QString &authid,
61 const QgsHttpHeaders &headers,
62 QgsFeedback *feedback = nullptr );
63
64};
65
66class CORE_EXPORT QgsXyzVectorTileDataProvider : public QgsXyzVectorTileDataProviderBase
67{
68 Q_OBJECT
69
70 public:
71 QgsXyzVectorTileDataProvider( const QString &uri,
72 const QgsDataProvider::ProviderOptions &providerOptions,
73 QgsDataProvider::ReadFlags flags );
74 QgsXyzVectorTileDataProvider( const QgsXyzVectorTileDataProvider &other );
75
79 QgsXyzVectorTileDataProvider &operator=( const QgsXyzVectorTileDataProvider &other ) = delete;
80
81 QString name() const override;
82 QString description() const override;
83 QgsVectorTileDataProvider *clone() const override;
84 QString sourcePath() const override;
85 bool isValid() const override;
86 QgsRectangle extent() const override;
87 QgsCoordinateReferenceSystem crs() const override;
88 const QgsVectorTileMatrixSet &tileMatrixSet() const override;
89
90 static QString XYZ_DATA_PROVIDER_KEY;
91 static QString XYZ_DATA_PROVIDER_DESCRIPTION;
92
93 protected:
94
95 bool mIsValid = false;
96 QgsRectangle mExtent;
97 QgsVectorTileMatrixSet mMatrixSet;
98
99 private:
100
102 static QByteArray loadFromNetwork( const QgsTileXYZ &id,
103 const QgsTileMatrix &tileMatrix,
104 const QString &requestUrl,
105 const QString &authid,
106 const QgsHttpHeaders &headers,
107 QgsFeedback *feedback = nullptr );
108
109};
110
111
112class QgsXyzVectorTileDataProviderMetadata : public QgsProviderMetadata
113{
114 Q_OBJECT
115 public:
116 QgsXyzVectorTileDataProviderMetadata();
117 QgsXyzVectorTileDataProvider *createProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() ) override;
118 QIcon icon() const override;
119 ProviderCapabilities providerCapabilities() const override;
120 QVariantMap decodeUri( const QString &uri ) const override;
121 QString encodeUri( const QVariantMap &parts ) const override;
122 QString absoluteToRelativeUri( const QString &uri, const QgsReadWriteContext &context ) const override;
123 QString relativeToAbsoluteUri( const QString &uri, const QgsReadWriteContext &context ) const override;
124 QList< Qgis::LayerType > supportedLayerTypes() const override;
125};
126
127
129
130#endif // QGSXYZVECTORTILEDATAPROVIDER_H
RendererUsage
Usage of the renderer.
Definition: qgis.h:2320
This class represents a coordinate reference system (CRS).
virtual QString name() const =0
Returns a provider name.
virtual QgsCoordinateReferenceSystem crs() const =0
Returns the coordinate system for the data source.
virtual bool isValid() const =0
Returns true if this is a valid layer.
virtual QString description() const =0
Returns description.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition: qgsfeedback.h:45
This class implements simple http header management.
Holds data provider key, description, and associated shared library file or function pointer informat...
virtual QgsProviderMetadata::ProviderCapabilities providerCapabilities() const
Returns the provider's capabilities.
virtual QIcon icon() const
Returns an icon representing the provider.
virtual QgsDataProvider * createProvider(const QString &uri, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags=QgsDataProvider::ReadFlags())
Class factory to return a pointer to a newly created QgsDataProvider object.
virtual QString encodeUri(const QVariantMap &parts) const
Reassembles a provider data source URI from its component paths (e.g.
virtual QString absoluteToRelativeUri(const QString &uri, const QgsReadWriteContext &context) const
Converts absolute path(s) to relative path(s) in the given provider-specific URI.
virtual QList< Qgis::LayerType > supportedLayerTypes() const
Returns a list of the map layer types supported by the provider.
virtual QString relativeToAbsoluteUri(const QString &uri, const QgsReadWriteContext &context) const
Converts relative path(s) to absolute path(s) in the given provider-specific URI.
virtual QVariantMap decodeUri(const QString &uri) const
Breaks a provider data source URI into its component paths (e.g.
The class is used as a container of context for various read/write operations on other objects.
A rectangle specified with double values.
Definition: qgsrectangle.h:42
Defines a set of tile matrices for multiple zoom levels.
Definition: qgstiles.h:250
Defines a matrix of tiles for a single zoom level: it is defined by its size (width *.
Definition: qgstiles.h:134
Stores coordinates of a tile in a tile matrix set.
Definition: qgstiles.h:38
Base class for vector tile layer data providers.
virtual QString sourcePath() const =0
Returns the source path for the data.
virtual QgsVectorTileDataProvider * clone() const =0
Returns a clone of the data provider.
QgsRectangle extent() const override
Returns the extent of the layer.
QgsVectorTileDataProvider & operator=(const QgsVectorTileDataProvider &other)=delete
QgsVectorTileDataProvider cannot be assigned.
virtual const QgsVectorTileMatrixSet & tileMatrixSet() const =0
Returns the tile matrix set associated with the provider.
virtual QList< QgsVectorTileRawData > readTiles(const QgsTileMatrixSet &tileMatrixSet, const QVector< QgsTileXYZ > &tiles, QgsFeedback *feedback=nullptr) const =0
Returns raw tile data for a range of tiles.
virtual QgsVectorTileRawData readTile(const QgsTileMatrixSet &tileMatrixSet, const QgsTileXYZ &id, QgsFeedback *feedback=nullptr) const =0
Returns raw tile data for a single tile.
virtual QNetworkRequest tileRequest(const QgsTileMatrixSet &tileMatrixSet, const QgsTileXYZ &id, Qgis::RendererUsage usage) const
Returns a network request for a tile.
virtual bool supportsAsync() const
Returns true if the provider supports async tile reading.
Encapsulates properties of a vector tile matrix set, including tile origins and scaling information.
Keeps track of raw tile data that need to be decoded.
Setting options for creating vector data providers.