QGIS API Documentation 3.35.0-Master (274c3da7543)
Loading...
Searching...
No Matches
qgsmbtilesvectortiledataprovider.h
Go to the documentation of this file.
1/***************************************************************************
2 qgsmbtilesvectortiledataprovider.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 QGSMBTILESVECTORTILEDATAPROVIDER_H
17#define QGSMBTILESVECTORTILEDATAPROVIDER_H
18
19#include "qgis_core.h"
20#include "qgis_sip.h"
22#include "qgsprovidermetadata.h"
24
25class QgsMbTiles;
26
27#define SIP_NO_FILE
28
30
31class CORE_EXPORT QgsMbTilesVectorTileDataProvider : public QgsVectorTileDataProvider
32{
33 Q_OBJECT
34
35 public:
36 QgsMbTilesVectorTileDataProvider( const QString &uri,
37 const QgsDataProvider::ProviderOptions &providerOptions,
38 QgsDataProvider::ReadFlags flags );
39
40 QgsMbTilesVectorTileDataProvider( const QgsMbTilesVectorTileDataProvider &other );
41
45 QgsMbTilesVectorTileDataProvider &operator=( const QgsMbTilesVectorTileDataProvider &other ) = delete;
46
47 QString name() const override;
48 QString description() const override;
49 QgsVectorTileDataProvider *clone() const override;
50 QString sourcePath() const override;
51 bool isValid() const override;
52 QgsRectangle extent() const override;
53 QgsCoordinateReferenceSystem crs() const override;
54 const QgsVectorTileMatrixSet &tileMatrixSet() const override;
55 QgsVectorTileRawData readTile( const QgsTileMatrixSet &tileMatrixSet, const QgsTileXYZ &id, QgsFeedback *feedback = nullptr ) const override;
56 QList<QgsVectorTileRawData> readTiles( const QgsTileMatrixSet &, const QVector<QgsTileXYZ> &tiles, QgsFeedback *feedback = nullptr, Qgis::RendererUsage usage = Qgis::RendererUsage::Unknown ) const override;
57
58 static QString MB_TILES_VECTOR_TILE_DATA_PROVIDER_KEY;
59 static QString MB_TILES_VECTOR_TILE_DATA_PROVIDER_DESCRIPTION;
60
61 private:
62
64 static QByteArray loadFromMBTiles( QgsMbTiles &mbTileReader, const QgsTileXYZ &id, QgsFeedback *feedback = nullptr );
65 bool mIsValid = false;
66 QgsRectangle mExtent;
67 QgsVectorTileMatrixSet mMatrixSet;
68
69};
70
71class QgsMbTilesVectorTileDataProviderMetadata : public QgsProviderMetadata
72{
73 Q_OBJECT
74 public:
75 QgsMbTilesVectorTileDataProviderMetadata();
76 QgsProviderMetadata::ProviderMetadataCapabilities capabilities() const override;
77 QgsMbTilesVectorTileDataProvider *createProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() ) override;
78 QIcon icon() const override;
79 ProviderCapabilities providerCapabilities() const override;
80 QString filters( Qgis::FileFilterType type ) override;
81 QList< QgsProviderSublayerDetails > querySublayers( const QString &uri, Qgis::SublayerQueryFlags flags = Qgis::SublayerQueryFlags(), QgsFeedback *feedback = nullptr ) const override;
82 int priorityForUri( const QString &uri ) const override;
83 QList< Qgis::LayerType > validLayerTypesForUri( const QString &uri ) const override;
84
85 QVariantMap decodeUri( const QString &uri ) const override;
86 QString encodeUri( const QVariantMap &parts ) const override;
87 QString absoluteToRelativeUri( const QString &uri, const QgsReadWriteContext &context ) const override;
88 QString relativeToAbsoluteUri( const QString &uri, const QgsReadWriteContext &context ) const override;
89 QList< Qgis::LayerType > supportedLayerTypes() const override;
90};
91
92
94
95#endif // QGSMBTILESVECTORTILEDATAPROVIDER_H
FileFilterType
Type of file filters.
Definition qgis.h:1046
RendererUsage
Usage of the renderer.
Definition qgis.h:2754
@ Unknown
Renderer used for unknown usage.
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
Utility class for reading and writing MBTiles files (which are SQLite3 databases).
Definition qgsmbtiles.h:39
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 int priorityForUri(const QString &uri) const
Returns an integer representing the priority which this provider should have when opening a dataset w...
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 QList< Qgis::LayerType > validLayerTypesForUri(const QString &uri) const
Returns a list of valid layer types which the provider can be used with when opening the specified ur...
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 QString filters(Qgis::FileFilterType type)
Builds the list of file filter strings (supported formats)
virtual QList< Qgis::LayerType > supportedLayerTypes() const
Returns a list of the map layer types supported by the provider.
virtual QList< QgsProviderSublayerDetails > querySublayers(const QString &uri, Qgis::SublayerQueryFlags flags=Qgis::SublayerQueryFlags(), QgsFeedback *feedback=nullptr) const
Queries the specified uri and returns a list of any valid sublayers found in the dataset which can be...
virtual QgsProviderMetadata::ProviderMetadataCapabilities capabilities() const
Returns the provider metadata capabilities.
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.
Defines a set of tile matrices for multiple zoom levels.
Definition qgstiles.h:250
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.
virtual QList< QgsVectorTileRawData > readTiles(const QgsTileMatrixSet &tileMatrixSet, const QVector< QgsTileXYZ > &tiles, QgsFeedback *feedback=nullptr, Qgis::RendererUsage usage=Qgis::RendererUsage::Unknown) const =0
Returns raw tile data for a range of tiles.
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 QgsVectorTileRawData readTile(const QgsTileMatrixSet &tileMatrixSet, const QgsTileXYZ &id, QgsFeedback *feedback=nullptr) const =0
Returns raw tile data for a single tile.
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.