QgsVectorTileLoader Class Reference

The loader class takes care of loading raw vector tile data from a tile source. More...

#include <qgsvectortileloader.h>

Inheritance diagram for QgsVectorTileLoader:

Signals
void	tileRequestFinished (const QgsVectorTileRawData &rawTile)
	Emitted when a tile request has finished. If a tile request has failed, the returned raw tile byte array is empty. More...

Public Member Functions
	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. More...
	~QgsVectorTileLoader ()
void	downloadBlocking ()
	Blocks the caller until all asynchronous requests are finished (with a success or a failure) More...
QString	error () const
	Returns a eventual error that occurred during loading, void if no error. More...

Static Public Member Functions
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, QgsFeedback *feedback=nullptr)
	Returns raw tile data for the specified range of tiles. Blocks the caller until all tiles are fetched. More...
static QByteArray	loadFromMBTiles (const QgsTileXYZ &id, QgsMbTiles &mbTileReader, QgsFeedback *feedback=nullptr)
	Returns raw tile data for a single tile loaded from MBTiles file. More...
static QByteArray	loadFromNetwork (const QgsTileXYZ &id, const QgsTileMatrix &tileMatrix, const QString &requestUrl, const QString &authid, const QgsHttpHeaders &headers, QgsFeedback *feedback=nullptr)
	Returns raw tile data for a single tile, doing a HTTP request. Block the caller until tile data are downloaded. More...
static QByteArray	loadFromVtpk (const QgsTileXYZ &id, QgsVtpkTiles &vtpkTileReader)
	Returns raw tile data for a single tile loaded from VTPK file. More...

Detailed Description

The loader class takes care of loading raw vector tile data from a tile source.

Since

QGIS 3.14

Definition at line 60 of file qgsvectortileloader.h.

Constructor & Destructor Documentation

QgsVectorTileLoader()

QgsVectorTileLoader::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.

Definition at line 33 of file qgsvectortileloader.cpp.

~QgsVectorTileLoader()

QgsVectorTileLoader::~QgsVectorTileLoader

(

)

Definition at line 58 of file qgsvectortileloader.cpp.

Member Function Documentation

blockingFetchTileRawData()

QList< QgsVectorTileRawData > QgsVectorTileLoader::blockingFetchTileRawData ( const QString &  sourceType, const QString &  sourcePath, const QgsTileMatrix &  tileMatrix, const QPointF &  viewCenter, const QgsTileRange &  range, const QString &  authid, const QgsHttpHeaders &  headers, QgsFeedback *  feedback = nullptr  )

static

Returns raw tile data for the specified range of tiles. Blocks the caller until all tiles are fetched.

Definition at line 175 of file qgsvectortileloader.cpp.

downloadBlocking()

void QgsVectorTileLoader::downloadBlocking

(

)

Blocks the caller until all asynchronous requests are finished (with a success or a failure)

Definition at line 70 of file qgsvectortileloader.cpp.

error()

QString QgsVectorTileLoader::error

(

)

const

Returns a eventual error that occurred during loading, void if no error.

Definition at line 168 of file qgsvectortileloader.cpp.

loadFromMBTiles()

QByteArray QgsVectorTileLoader::loadFromMBTiles ( const QgsTileXYZ &  id, QgsMbTiles &  mbTileReader, QgsFeedback *  feedback = nullptr  )

static

Returns raw tile data for a single tile loaded from MBTiles file.

Definition at line 243 of file qgsvectortileloader.cpp.

loadFromNetwork()

QByteArray QgsVectorTileLoader::loadFromNetwork ( const QgsTileXYZ &  id, const QgsTileMatrix &  tileMatrix, const QString &  requestUrl, const QString &  authid, const QgsHttpHeaders &  headers, QgsFeedback *  feedback = nullptr  )

static

Returns raw tile data for a single tile, doing a HTTP request. Block the caller until tile data are downloaded.

Definition at line 220 of file qgsvectortileloader.cpp.

loadFromVtpk()

QByteArray QgsVectorTileLoader::loadFromVtpk ( const QgsTileXYZ &  id, QgsVtpkTiles &  vtpkTileReader  )

static

Returns raw tile data for a single tile loaded from VTPK file.

Definition at line 267 of file qgsvectortileloader.cpp.

tileRequestFinished

void QgsVectorTileLoader::tileRequestFinished ( const QgsVectorTileRawData &  rawTile )

signal

Emitted when a tile request has finished. If a tile request has failed, the returned raw tile byte array is empty.

---

The documentation for this class was generated from the following files:

• /build/qgis-3.28.0+99sid/src/core/vectortile/qgsvectortileloader.h
• /build/qgis-3.28.0+99sid/src/core/vectortile/qgsvectortileloader.cpp