QgsTileMatrix Class Reference

Defines a matrix of tiles for a single zoom level: it is defined by its size (width *. More...

#include <qgstiles.h>

Public Member Functions
QgsCoordinateReferenceSystem	crs () const
	Returns the crs of the tile matrix.
QgsRectangle	extent () const
	Returns extent of the tile matrix.
bool	isRootTileMatrix () const
	Returns the root status of the tile matrix (zoom level == 0)
QPointF	mapToTileCoordinates (const QgsPointXY &mapPoint) const
	Returns row/column coordinates (floating point number) from the given point in map coordinates.
int	matrixHeight () const
	Returns number of rows of the tile matrix.
int	matrixWidth () const
	Returns number of columns of the tile matrix.
double	scale () const
	Returns scale denominator of the tile matrix.
void	setCrs (const QgsCoordinateReferenceSystem &crs)
	Sets the crs of the tile matrix.
void	setScale (double scale)
	Sets the scale denominator of the tile matrix.
void	setZoomLevel (int level)
	Sets the zoom level of the tile matrix.
QgsPointXY	tileCenter (QgsTileXYZ id) const
	Returns center of the given tile in this matrix.
QgsRectangle	tileExtent (QgsTileXYZ id) const
	Returns extent of the given tile in this matrix.
QgsTileRange	tileRangeFromExtent (const QgsRectangle &mExtent) const
	Returns tile range that fully covers the given extent.
int	zoomLevel () const
	Returns the zoom level of the tile matrix.

Static Public Member Functions
static QgsTileMatrix	fromCustomDef (int zoomLevel, const QgsCoordinateReferenceSystem &crs, const QgsPointXY &z0TopLeftPoint, double z0Dimension, int z0MatrixWidth=1, int z0MatrixHeight=1)
	Returns a tile matrix for a specific CRS, top left point, zoom level 0 dimension in CRS units.
static QgsTileMatrix	fromTileMatrix (int zoomLevel, const QgsTileMatrix &tileMatrix)
	Returns a tile matrix based on another one.
static QgsTileMatrix	fromWebMercator (int zoomLevel)
	Returns a tile matrix for the usual web mercator.

Friends
class	QgsTileMatrixSet

Detailed Description

Defines a matrix of tiles for a single zoom level: it is defined by its size (width *.

height) and map extent that it covers.

Please note that we follow the XYZ convention of X/Y axes, i.e. top-left tile has [0,0] coordinate (which is different from TMS convention where bottom-left tile has [0,0] coordinate).

Since

QGIS 3.14

Definition at line 135 of file qgstiles.h.

Member Function Documentation

crs()

QgsCoordinateReferenceSystem QgsTileMatrix::crs ( ) const

inline

Returns the crs of the tile matrix.

See also

setCrs()

Definition at line 159 of file qgstiles.h.

extent()

QgsRectangle QgsTileMatrix::extent ( ) const

inline

Returns extent of the tile matrix.

Definition at line 191 of file qgstiles.h.

fromCustomDef()

QgsTileMatrix QgsTileMatrix::fromCustomDef ( int  zoomLevel, const QgsCoordinateReferenceSystem &  crs, const QgsPointXY &  z0TopLeftPoint, double  z0Dimension, int  z0MatrixWidth = 1, int  z0MatrixHeight = 1  )

static

Returns a tile matrix for a specific CRS, top left point, zoom level 0 dimension in CRS units.

The z0Dimension argument must specify the dimension (width or height, in map units) of the root tiles in zoom level 0.

Definition at line 31 of file qgstiles.cpp.

fromTileMatrix()

QgsTileMatrix QgsTileMatrix::fromTileMatrix ( int  zoomLevel, const QgsTileMatrix &  tileMatrix  )

static

Returns a tile matrix based on another one.

Definition at line 61 of file qgstiles.cpp.

fromWebMercator()

QgsTileMatrix QgsTileMatrix::fromWebMercator ( int  zoomLevel )

static

Returns a tile matrix for the usual web mercator.

Definition at line 23 of file qgstiles.cpp.

isRootTileMatrix()

bool QgsTileMatrix::isRootTileMatrix ( ) const

inline

Returns the root status of the tile matrix (zoom level == 0)

Definition at line 221 of file qgstiles.h.

mapToTileCoordinates()

QPointF QgsTileMatrix::mapToTileCoordinates

(

const QgsPointXY &

mapPoint

)

const

Returns row/column coordinates (floating point number) from the given point in map coordinates.

Definition at line 121 of file qgstiles.cpp.

matrixHeight()

int QgsTileMatrix::matrixHeight ( ) const

inline

Returns number of rows of the tile matrix.

Definition at line 188 of file qgstiles.h.

matrixWidth()

int QgsTileMatrix::matrixWidth ( ) const

inline

Returns number of columns of the tile matrix.

Definition at line 185 of file qgstiles.h.

scale()

double QgsTileMatrix::scale ( ) const

inline

Returns scale denominator of the tile matrix.

See also

setScale()

Definition at line 198 of file qgstiles.h.

setCrs()

void QgsTileMatrix::setCrs ( const QgsCoordinateReferenceSystem &  crs )

inline

Sets the crs of the tile matrix.

See also

crs()

Since

QGIS 3.22.6

Definition at line 167 of file qgstiles.h.

setScale()

void QgsTileMatrix::setScale ( double  scale )

inline

Sets the scale denominator of the tile matrix.

See also

scale()

Since

QGIS 3.22.6

Definition at line 206 of file qgstiles.h.

setZoomLevel()

void QgsTileMatrix::setZoomLevel ( int  level )

inline

Sets the zoom level of the tile matrix.

See also

zoomLevel()

Since

QGIS 3.22.6

Definition at line 182 of file qgstiles.h.

tileCenter()

QgsPointXY QgsTileMatrix::tileCenter

(

QgsTileXYZ

id

)

const

Returns center of the given tile in this matrix.

Definition at line 90 of file qgstiles.cpp.

tileExtent()

QgsRectangle QgsTileMatrix::tileExtent

(

QgsTileXYZ

id

)

const

Returns extent of the given tile in this matrix.

Definition at line 81 of file qgstiles.cpp.

tileRangeFromExtent()

QgsTileRange QgsTileMatrix::tileRangeFromExtent

(

const QgsRectangle &

mExtent

)

const

Returns tile range that fully covers the given extent.

Definition at line 97 of file qgstiles.cpp.

zoomLevel()

int QgsTileMatrix::zoomLevel ( ) const

inline

Returns the zoom level of the tile matrix.

See also

setZoomLevel()

Definition at line 174 of file qgstiles.h.

Friends And Related Symbol Documentation

QgsTileMatrixSet

friend class QgsTileMatrixSet

friend

Definition at line 241 of file qgstiles.h.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgstiles.h
• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/qgstiles.cpp