Utility class for reading and writing MBTiles files (which are SQLite3 databases). More...

#include <qgsmbtiles.h>

Public Member Functions
	QgsMbTiles (const QString &filename)
	Constructs MBTiles reader (but it does not open the file yet) More...

bool	create ()
	Creates a new MBTiles file and initializes it with metadata and tiles tables. More...

QgsRectangle	extent ()
	Returns bounding box from metadata, given in WGS 84 (if available) More...

bool	isOpen () const
	Returns whether the MBTiles file is currently opened. More...

QString	metadataValue (const QString &key)
	Requests metadata value for the given key. More...

bool	open ()
	Tries to open the file, returns true on success. More...

void	setMetadataValue (const QString &key, const QString &value)
	Sets metadata value for the given key. More...

void	setTileData (int z, int x, int y, const QByteArray &data)
	Adds tile data for the given tile coordinates. More...

QByteArray	tileData (int z, int x, int y)
	Returns raw tile data for given tile. More...

QImage	tileDataAsImage (int z, int x, int y)
	Returns tile decoded as a raster image (if stored in a known format like JPG or PNG) More...

Static Public Member Functions
static bool	decodeGzip (const QByteArray &bytesIn, QByteArray &bytesOut)
	Decodes gzip byte stream, returns true on success. Useful for reading vector tiles. More...

static bool	encodeGzip (const QByteArray &bytesIn, QByteArray &bytesOut)
	Encodes gzip byte stream, returns true on success. Useful for writing vector tiles. More...

Detailed Description

Utility class for reading and writing MBTiles files (which are SQLite3 databases).

See the specification for more details: https://github.com/mapbox/mbtiles-spec/blob/master/1.3/spec.md

Since: QGIS 3.14

Definition at line 38 of file qgsmbtiles.h.

Constructor & Destructor Documentation

◆ QgsMbTiles()

QgsMbTiles::QgsMbTiles ( const QString & filename )

explicit

Constructs MBTiles reader (but it does not open the file yet)

Definition at line 27 of file qgsmbtiles.cpp.

Member Function Documentation

◆ create()

bool QgsMbTiles::create ( )

Creates a new MBTiles file and initializes it with metadata and tiles tables.

It is up to the caller to set appropriate metadata entries and add tiles afterwards. Returns true on success. If the file exists already, returns false.

Definition at line 52 of file qgsmbtiles.cpp.

◆ decodeGzip()

bool QgsMbTiles::decodeGzip	(	const QByteArray &	bytesIn,
		QByteArray &	bytesOut
	)

static

Decodes gzip byte stream, returns true on success. Useful for reading vector tiles.

Definition at line 211 of file qgsmbtiles.cpp.

◆ encodeGzip()

bool QgsMbTiles::encodeGzip	(	const QByteArray &	bytesIn,
		QByteArray &	bytesOut
	)

static

Encodes gzip byte stream, returns true on success. Useful for writing vector tiles.

Definition at line 267 of file qgsmbtiles.cpp.

◆ extent()

QgsRectangle QgsMbTiles::extent ( )

Returns bounding box from metadata, given in WGS 84 (if available)

Definition at line 133 of file qgsmbtiles.cpp.

◆ isOpen()

bool QgsMbTiles::isOpen ( ) const

Returns whether the MBTiles file is currently opened.

Definition at line 47 of file qgsmbtiles.cpp.

◆ metadataValue()

QString QgsMbTiles::metadataValue ( const QString & key )

Requests metadata value for the given key.

Definition at line 83 of file qgsmbtiles.cpp.

◆ open()

bool QgsMbTiles::open ( )

Tries to open the file, returns true on success.

Definition at line 32 of file qgsmbtiles.cpp.

◆ setMetadataValue()

void QgsMbTiles::setMetadataValue	(	const QString &	key,
		const QString &	value
	)

Sets metadata value for the given key.

Does not overwrite existing entries.

Note: the database has to be opened in read-write mode (currently only when opened with create()

Definition at line 109 of file qgsmbtiles.cpp.

◆ setTileData()

void QgsMbTiles::setTileData	(	int	z,
		int	x,
		int	y,
		const QByteArray &	data
	)

Adds tile data for the given tile coordinates.

Does not overwrite existing entries.

Note: the database has to be opened in read-write mode (currently only when opened with create()

Definition at line 185 of file qgsmbtiles.cpp.

◆ tileData()

QByteArray QgsMbTiles::tileData	(	int	z,
		int	x,
		int	y
	)

Returns raw tile data for given tile.

Definition at line 146 of file qgsmbtiles.cpp.

◆ tileDataAsImage()

QImage QgsMbTiles::tileDataAsImage	(	int	z,
		int	x,
		int	y
	)

Returns tile decoded as a raster image (if stored in a known format like JPG or PNG)

Definition at line 173 of file qgsmbtiles.cpp.

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

/build/qgis-3.24.2+99sid/src/core/qgsmbtiles.h
/build/qgis-3.24.2+99sid/src/core/qgsmbtiles.cpp

Public Member Functions

Static Public Member Functions