QGIS API Documentation 3.29.0-Master (006c3c0232)
Public Member Functions | List of all members
QgsVtpkTiles Class Reference

Utility class for reading and writing ESRI VTPK files. More...

#include <qgsvtpktiles.h>

Public Member Functions

 QgsVtpkTiles (const QgsVtpkTiles &other)=delete
 QgsVtpkTiles cannot be copied. More...
 
 QgsVtpkTiles (const QString &filename)
 Constructs VTPK reader (but it does not open the file yet) More...
 
 ~QgsVtpkTiles ()
 
QgsCoordinateReferenceSystem crs () const
 Returns the coordinate reference system of the tiles. More...
 
QgsRectangle extent (const QgsCoordinateTransformContext &context) const
 Returns bounding box from metadata, given in the tiles crs(). More...
 
bool isOpen () const
 Returns whether the VTPK file is currently opened. More...
 
QgsLayerMetadata layerMetadata () const
 Reads layer metadata from the VTPK file. More...
 
QgsVectorTileMatrixSet matrixSet () const
 Returns the vector tile matrix set representing the tiles. More...
 
QVariantMap metadata () const
 Returns the VTPK metadata. More...
 
bool open ()
 Tries to open the file, returns true on success. More...
 
QgsVtpkTilesoperator= (const QgsVtpkTiles &other)=delete
 QgsVtpkTiles cannot be copied. More...
 
QVariantMap spriteDefinition () const
 Returns the VTPK sprites definitions. More...
 
QImage spriteImage () const
 Returns the VTPK sprite image, if it exists. More...
 
QVariantMap styleDefinition () const
 Returns the VTPK style definition. More...
 
QByteArray tileData (int z, int x, int y)
 Returns the raw tile data for the matching tile. More...
 

Detailed Description

Utility class for reading and writing ESRI VTPK files.

Since
QGIS 3.26

Definition at line 37 of file qgsvtpktiles.h.

Constructor & Destructor Documentation

◆ QgsVtpkTiles() [1/2]

QgsVtpkTiles::QgsVtpkTiles ( const QString &  filename)
explicit

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

Definition at line 35 of file qgsvtpktiles.cpp.

◆ QgsVtpkTiles() [2/2]

QgsVtpkTiles::QgsVtpkTiles ( const QgsVtpkTiles other)
delete

QgsVtpkTiles cannot be copied.

◆ ~QgsVtpkTiles()

QgsVtpkTiles::~QgsVtpkTiles ( )

Definition at line 40 of file qgsvtpktiles.cpp.

Member Function Documentation

◆ crs()

QgsCoordinateReferenceSystem QgsVtpkTiles::crs ( ) const

Returns the coordinate reference system of the tiles.

Definition at line 342 of file qgsvtpktiles.cpp.

◆ extent()

QgsRectangle QgsVtpkTiles::extent ( const QgsCoordinateTransformContext context) const

Returns bounding box from metadata, given in the tiles crs().

Definition at line 347 of file qgsvtpktiles.cpp.

◆ isOpen()

bool QgsVtpkTiles::isOpen ( ) const

Returns whether the VTPK file is currently opened.

Definition at line 84 of file qgsvtpktiles.cpp.

◆ layerMetadata()

QgsLayerMetadata QgsVtpkTiles::layerMetadata ( ) const

Reads layer metadata from the VTPK file.

Definition at line 244 of file qgsvtpktiles.cpp.

◆ matrixSet()

QgsVectorTileMatrixSet QgsVtpkTiles::matrixSet ( ) const

Returns the vector tile matrix set representing the tiles.

Definition at line 333 of file qgsvtpktiles.cpp.

◆ metadata()

QVariantMap QgsVtpkTiles::metadata ( ) const

Returns the VTPK metadata.

This method returns the contents of the "root.json" file.

Definition at line 89 of file qgsvtpktiles.cpp.

◆ open()

bool QgsVtpkTiles::open ( )

Tries to open the file, returns true on success.

Definition at line 49 of file qgsvtpktiles.cpp.

◆ operator=()

QgsVtpkTiles & QgsVtpkTiles::operator= ( const QgsVtpkTiles other)
delete

QgsVtpkTiles cannot be copied.

◆ spriteDefinition()

QVariantMap QgsVtpkTiles::spriteDefinition ( ) const

Returns the VTPK sprites definitions.

Definition at line 157 of file qgsvtpktiles.cpp.

◆ spriteImage()

QImage QgsVtpkTiles::spriteImage ( ) const

Returns the VTPK sprite image, if it exists.

Definition at line 200 of file qgsvtpktiles.cpp.

◆ styleDefinition()

QVariantMap QgsVtpkTiles::styleDefinition ( ) const

Returns the VTPK style definition.

Definition at line 124 of file qgsvtpktiles.cpp.

◆ tileData()

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

Returns the raw tile data for the matching tile.

Definition at line 376 of file qgsvtpktiles.cpp.


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