QGIS API Documentation 3.35.0-Master (728e5967df5)
No Matches
Go to the documentation of this file.
2 qgsvtpkvectortiledataprovider.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 ***************************************************************************/
19#include "qgis_core.h"
20#include "qgis_sip.h"
22#include "qgsprovidermetadata.h"
25#include <QImage>
27#define SIP_NO_FILE
31class QgsVtpkTiles;
33class CORE_EXPORT QgsVtpkVectorTileDataProvider : public QgsVectorTileDataProvider
37 public:
38 QgsVtpkVectorTileDataProvider( const QString &uri,
39 const QgsDataProvider::ProviderOptions &providerOptions,
40 QgsDataProvider::ReadFlags flags );
41 QgsVtpkVectorTileDataProvider( const QgsVtpkVectorTileDataProvider &other );
46 QgsVtpkVectorTileDataProvider &operator=( const QgsVtpkVectorTileDataProvider &other ) = delete;
48 Qgis::VectorTileProviderFlags providerFlags() const override;
49 Qgis::VectorTileProviderCapabilities providerCapabilities() const override;
50 QString name() const override;
51 QString description() const override;
52 QgsVectorTileDataProvider *clone() const override;
53 QString sourcePath() const override;
54 bool isValid() const override;
55 QgsCoordinateReferenceSystem crs() const override;
56 QgsRectangle extent() const override;
57 QgsLayerMetadata layerMetadata() const override;
58 const QgsVectorTileMatrixSet &tileMatrixSet() const override;
59 QVariantMap styleDefinition() const override;
60 QVariantMap spriteDefinition() const override;
61 QImage spriteImage() const override;
62 QgsVectorTileRawData readTile( const QgsTileMatrixSet &tileMatrix, const QgsTileXYZ &id, QgsFeedback *feedback = nullptr ) const override;
63 QList<QgsVectorTileRawData> readTiles( const QgsTileMatrixSet &, const QVector<QgsTileXYZ> &tiles, QgsFeedback *feedback = nullptr, Qgis::RendererUsage usage = Qgis::RendererUsage::Unknown ) const override;
64 QString htmlMetadata() const override;
66 static QString DATA_PROVIDER_KEY;
69 private:
72 static QgsVectorTileRawData loadFromVtpk( QgsVtpkTiles &vtpkTileReader, const QgsTileXYZ &id, QgsFeedback *feedback = nullptr );
73 bool mIsValid = false;
75 QgsRectangle mExtent;
76 QgsVectorTileMatrixSet mMatrixSet;
77 QgsLayerMetadata mLayerMetadata;
78 QVariantMap mStyleDefinition;
79 QVariantMap mSpriteDefinition;
80 QImage mSpriteImage;
85class QgsVtpkVectorTileDataProviderMetadata : public QgsProviderMetadata
88 public:
89 QgsVtpkVectorTileDataProviderMetadata();
90 QgsProviderMetadata::ProviderMetadataCapabilities capabilities() const override;
91 QgsVtpkVectorTileDataProvider *createProvider( const QString &uri, const QgsDataProvider::ProviderOptions &options, QgsDataProvider::ReadFlags flags = QgsDataProvider::ReadFlags() ) override;
92 QIcon icon() const override;
93 ProviderCapabilities providerCapabilities() const override;
94 QString filters( Qgis::FileFilterType type ) override;
95 QList< QgsProviderSublayerDetails > querySublayers( const QString &uri, Qgis::SublayerQueryFlags flags = Qgis::SublayerQueryFlags(), QgsFeedback *feedback = nullptr ) const override;
96 int priorityForUri( const QString &uri ) const override;
97 QList< Qgis::LayerType > validLayerTypesForUri( const QString &uri ) const override;
98 QVariantMap decodeUri( const QString &uri ) const override;
99 QString encodeUri( const QVariantMap &parts ) const override;
100 QString absoluteToRelativeUri( const QString &uri, const QgsReadWriteContext &context ) const override;
101 QString relativeToAbsoluteUri( const QString &uri, const QgsReadWriteContext &context ) const override;
102 QList< Qgis::LayerType > supportedLayerTypes() const override;
Type of file filters.
Definition qgis.h:1013
Usage of the renderer.
Definition qgis.h:2626
@ 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 QgsLayerMetadata layerMetadata() const
Returns layer metadata collected from the provider's source.
virtual bool isValid() const =0
Returns true if this is a valid layer.
virtual QString description() const =0
Returns description.
virtual QString htmlMetadata() const
Obtain a formatted HTML string containing assorted metadata for this data provider.
Base class for feedback objects to be used for cancellation of something running in a worker thread.
Definition qgsfeedback.h:45
A structured metadata store for a map layer.
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 Qgis::VectorTileProviderCapabilities providerCapabilities() const
Returns flags containing the supported capabilities of the data provider.
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.
virtual Qgis::VectorTileProviderFlags providerFlags() const
Returns flags reflecting the behavior of the data provider.
virtual QVariantMap spriteDefinition() const
Returns the sprite definition for the provider, if available.
virtual QVariantMap styleDefinition() const
Returns the style definition for the provider, if available.
virtual QImage spriteImage() const
Returns the sprite image for the provider, if available.
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.
Utility class for reading and writing ESRI VTPK files.
Setting options for creating vector data providers.