QGIS API Documentation  3.23.0-Master (c716e02dd3)
qgsvectortileloader.h
Go to the documentation of this file.
1 /***************************************************************************
2  qgsvectortileloader.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 QGSVECTORTILELOADER_H
17 #define QGSVECTORTILELOADER_H
18 
19 #define SIP_NO_FILE
20 
21 class QByteArray;
22 
23 #include "qgsvectortilerenderer.h"
24 #include "qgshttpheaders.h"
25 
33 {
34  public:
36  QgsVectorTileRawData( QgsTileXYZ tileID = QgsTileXYZ(), const QByteArray &raw = QByteArray() )
37  : id( tileID ), data( raw ) {}
38 
42  QByteArray data;
43 };
44 
45 
46 class QNetworkReply;
47 class QEventLoop;
48 
49 class QgsMbTiles;
50 
52 
59 class QgsVectorTileLoader : public QObject
60 {
61  Q_OBJECT
62  public:
63 
65  static QList<QgsVectorTileRawData> blockingFetchTileRawData( const QString &sourceType,
66  const QString &sourcePath,
67  const QgsTileMatrix &tileMatrix,
68  const QPointF &viewCenter,
69  const QgsTileRange &range,
70  const QString &authid,
71  const QgsHttpHeaders &headers );
72 
74  static QByteArray loadFromNetwork( const QgsTileXYZ &id,
75  const QgsTileMatrix &tileMatrix,
76  const QString &requestUrl,
77  const QString &authid,
78  const QgsHttpHeaders &headers );
80  static QByteArray loadFromMBTiles( const QgsTileXYZ &id, QgsMbTiles &mbTileReader );
81 
82  //
83  // non-static stuff
84  //
85 
87  QgsVectorTileLoader( const QString &uri, const QgsTileMatrix &tileMatrix, const QgsTileRange &range, const QPointF &viewCenter,
88  const QString &authid, const QgsHttpHeaders &headers, QgsFeedback *feedback );
90 
92  void downloadBlocking();
93 
95  QString error() const;
96 
97  private:
98  void loadFromNetworkAsync( const QgsTileXYZ &id, const QgsTileMatrix &tileMatrix, const QString &requestUrl );
99 
100  private slots:
101  void tileReplyFinished();
102  void canceled();
103 
104  signals:
107 
108  private:
110  std::unique_ptr<QEventLoop> mEventLoop;
112  QgsFeedback *mFeedback;
113 
114  QString mAuthCfg;
115  QgsHttpHeaders mHeaders;
116 
118  QList<QgsTileDownloadManagerReply *> mReplies;
119 
120  QString mError;
121 
122 };
123 
124 #endif // QGSVECTORTILELOADER_H
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.
Utility class for reading and writing MBTiles files (which are SQLite3 databases).
Definition: qgsmbtiles.h:39
Reply object for tile download manager requests returned from calls to QgsTileDownloadManager::get().
Defines a matrix of tiles for a single zoom level: it is defined by its size (width *.
Definition: qgstiles.h:104
Range of tiles in a tile matrix to be rendered.
Definition: qgstiles.h:67
Stores coordinates of a tile in a tile matrix set.
Definition: qgstiles.h:34
The loader class takes care of loading raw vector tile data from a tile source.
void tileRequestFinished(const QgsVectorTileRawData &rawTile)
Emitted when a tile request has finished. If a tile request has failed, the returned raw tile byte ar...
static QList< QgsVectorTileRawData > blockingFetchTileRawData(const QString &sourceType, const QString &sourcePath, const QgsTileMatrix &tileMatrix, const QPointF &viewCenter, const QgsTileRange &range, const QString &authid, const QgsHttpHeaders &headers)
Returns raw tile data for the specified range of tiles. Blocks the caller until all tiles are fetched...
QString error() const
Returns a eventual error that occurred during loading, void if no error.
static QByteArray loadFromMBTiles(const QgsTileXYZ &id, QgsMbTiles &mbTileReader)
Returns raw tile data for a single tile loaded from MBTiles file.
void downloadBlocking()
Blocks the caller until all asynchronous requests are finished (with a success or a failure)
QgsVectorTileLoader(const QString &uri, const QgsTileMatrix &tileMatrix, const QgsTileRange &range, const QPointF &viewCenter, const QString &authid, const QgsHttpHeaders &headers, QgsFeedback *feedback)
Constructs tile loader for doing asynchronous requests and starts network requests.
static QByteArray loadFromNetwork(const QgsTileXYZ &id, const QgsTileMatrix &tileMatrix, const QString &requestUrl, const QString &authid, const QgsHttpHeaders &headers)
Returns raw tile data for a single tile, doing a HTTP request. Block the caller until tile data are d...
Keeps track of raw tile data that need to be decoded.
QgsVectorTileRawData(QgsTileXYZ tileID=QgsTileXYZ(), const QByteArray &raw=QByteArray())
Constructs a raw tile object.
QByteArray data
Raw tile data.
QgsTileXYZ id
Tile position in tile matrix set.