A raster overlay that directly accesses a Web Map Tile Service (WMTS) server. More...

Inheritance diagram for CesiumForUnity.CesiumWebMapTileServiceRasterOverlay:

Protected Member Functions
override partial void	AddToTileset (Cesium3DTileset tileset)

override partial void	RemoveFromTileset (Cesium3DTileset tileset)

Protected Member Functions inherited from CesiumForUnity.CesiumRasterOverlay
void	AddToTileset (Cesium3DTileset tileset)
	When implemented in a derived class, adds the raster overlay to the given tileset.

void	RemoveFromTileset (Cesium3DTileset tileset)
	When implemented in a derived class, removes the raster overlay from the given tileset.

Properties
string	baseUrl `[get, set]`
	The base URL of the Web Map Tile Service (WMTS).

string	layer `[get, set]`
	The layer name to use for WMTS requests.

string	style `[get, set]`
	The style name to use for WMTS requests.

string	format `[get, set]`
	The MIME type for images to retrieve from the server.

string	tileMatrixSetID `[get, set]`
	The identifier of the TileMatrixSet to use for WMTS requests.

string	tileMatrixSetLabelPrefix `[get, set]`
	The prefix to use for the tile matrix set labels.

bool	specifyTileMatrixSetLabels `[get, set]`
	Set this to true to manually specify the tile matrix set labels.

List< string >	tileMatrixSetLabels `[get, set]`
	The manually specified tile matrix set labels.

CesiumWebMapTileServiceRasterOverlayProjection	projection `[get, set]`
	The type of projection used to project the WMTS imagery onto the globe.

bool	specifyTilingScheme `[get, set]`
	Set this to true to specify the quadtree tiling scheme according to the specified projection, root tile numbers, and bounding rectangle.

int	rootTilesX `[get, set]`
	The number of tiles corresponding to TileCol, also known as TileMatrixWidth.

int	rootTilesY `[get, set]`
	The number of tiles corresponding to TileRow, also known as TileMatrixHeight.

double	rectangleWest `[get, set]`
	The west boundary of the bounding rectangle used for the quadtree tiling scheme.

double	rectangleSouth `[get, set]`
	The south boundary of the bounding rectangle used for the quadtree tiling scheme.

double	rectangleEast `[get, set]`
	The east boundary of the bounding rectangle used for the quadtree tiling scheme.

double	rectangleNorth `[get, set]`
	The north boundary of the bounding rectangle used for the quadtree tiling scheme.

bool	specifyZoomLevels `[get, set]`
	Set this to true to directly specify the minimum and maximum zoom levels available from the server.

int	minimumLevel `[get, set]`
	The minimum level-of-detail supported by the imagery provider.

int	maximumLevel `[get, set]`
	The maximum level-of-detail supported by the imagery provider.

int	tileWidth `[get, set]`
	The pixel width of the image tiles.

int	tileHeight `[get, set]`
	The pixel height of the image tiles.

Properties inherited from CesiumForUnity.CesiumRasterOverlay
string	materialKey `[get, set]`
	The key to use to match this overlay to the corresponding parameters in the tileset's material.

bool	showCreditsOnScreen `[get, set]`
	Whether or not to force this raster overlay's credits to be shown on the main screen.

float	maximumScreenSpaceError `[get, set]`
	The maximum number of pixels of error when rendering this overlay.

int	maximumTextureSize `[get, set]`
	The maximum texel size of raster overlay textures, in either direction.

int	maximumSimultaneousTileLoads `[get, set]`
	The maximum number of overlay tiles that may simultaneously be in the process of loading.

long	subTileCacheBytes `[get, set]`
	The maximum number of bytes to use to cache sub-tiles in memory.

Additional Inherited Members
Public Member Functions inherited from CesiumForUnity.CesiumRasterOverlay
delegate void	RasterOverlayLoadFailureDelegate (CesiumRasterOverlayLoadFailureDetails details)
	Encapsulates a method that receives details of a raster overlay load failure.

void	AddToTileset ()
	Adds this raster overlay to the Cesium3DTileset on the same game object.

void	RemoveFromTileset ()
	Removes this raster overlay from the Cesium3DTileset on the same game object.

void	Refresh ()
	Refreshes this overlay by calling RemoveFromTileset followed by AddToTileset.

Static Package Functions inherited from CesiumForUnity.CesiumRasterOverlay
Events inherited from CesiumForUnity.CesiumRasterOverlay
static RasterOverlayLoadFailureDelegate	OnCesiumRasterOverlayLoadFailure
	An event that is raised when the raster overlay encounters an error that prevents it from loading.

Detailed Description

A raster overlay that directly accesses a Web Map Tile Service (WMTS) server.

https://www.ogc.org/standards/wmts

Definition at line 33 of file CesiumWebMapTileServiceRasterOverlay.cs.

Member Function Documentation

◆ AddToTileset()

override partial void CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.AddToTileset ( Cesium3DTileset tileset )

protected

◆ RemoveFromTileset()

override partial void CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.RemoveFromTileset ( Cesium3DTileset tileset )

protected

Property Documentation

◆ baseUrl

string CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.baseUrl

getset

The base URL of the Web Map Tile Service (WMTS).

This URL should not include query parameters. For example: https://tile.openstreetmap.org/{TileMatrix}/{TileCol}/{TileRow}.png

Definition at line 47 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ format

string CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.format

getset

The MIME type for images to retrieve from the server.

The default value is "image/jpeg".

Definition at line 95 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ layer

string CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.layer

getset

The layer name to use for WMTS requests.

Definition at line 63 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ maximumLevel

int CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.maximumLevel

getset

The maximum level-of-detail supported by the imagery provider.

Only applicable if specifyZoomLevels is set to true.

Definition at line 364 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ minimumLevel

int CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.minimumLevel

getset

The minimum level-of-detail supported by the imagery provider.

Only applicable if specifyZoomLevels is set to true.

Definition at line 347 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ projection

CesiumWebMapTileServiceRasterOverlayProjection CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.projection

getset

The type of projection used to project the WMTS imagery onto the globe.

For instance, EPSG:4326 uses geographic projection and EPSG:3857 uses Web Mercator.

Definition at line 182 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ rectangleEast

double CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.rectangleEast

getset

The east boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in longitude degrees in the range [-180, 180]. Only applicable if specifyTilingScheme is set to true.

Definition at line 294 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ rectangleNorth

double CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.rectangleNorth

getset

The north boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in latitude degrees in the range [-90, 90]. Only applicable if specifyTilingScheme is set to true.

Definition at line 312 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ rectangleSouth

double CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.rectangleSouth

getset

The south boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in latitude degrees in the range [-90, 90]. Only applicable if specifyTilingScheme is set to true.

Definition at line 276 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ rectangleWest

double CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.rectangleWest

getset

The west boundary of the bounding rectangle used for the quadtree tiling scheme.

Specified in longitude degrees in the range [-180, 180]. Only applicable if specifyTilingScheme is set to true.

Definition at line 258 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ rootTilesX

int CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.rootTilesX

getset

The number of tiles corresponding to TileCol, also known as TileMatrixWidth.

If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the X direction. Only applicable if specifyTilingScheme is set to true.

Definition at line 220 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ rootTilesY

int CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.rootTilesY

getset

The number of tiles corresponding to TileRow, also known as TileMatrixHeight.

If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the Y direction. Only applicable if specifyTilingScheme is set to true.

Definition at line 240 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ specifyTileMatrixSetLabels

bool CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.specifyTileMatrixSetLabels

getset

Set this to true to manually specify the tile matrix set labels.

If false, the labels will be constructed from the specified levels and prefix (if one is specified).

Definition at line 148 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ specifyTilingScheme

bool CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.specifyTilingScheme

getset

Set this to true to specify the quadtree tiling scheme according to the specified projection, root tile numbers, and bounding rectangle.

If false, the tiling scheme will be deduced from the projection.

Definition at line 200 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ specifyZoomLevels

bool CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.specifyZoomLevels

getset

Set this to true to directly specify the minimum and maximum zoom levels available from the server.

If false, the minimum and maximum zoom levels will be retrieved from the server's tilemapresource.xml file.

Definition at line 330 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ style

string CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.style

getset

The style name to use for WMTS requests.

Definition at line 79 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ tileHeight

int CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.tileHeight

getset

The pixel height of the image tiles.

Definition at line 396 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ tileMatrixSetID

string CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.tileMatrixSetID

getset

The identifier of the TileMatrixSet to use for WMTS requests.

Definition at line 111 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ tileMatrixSetLabelPrefix

string CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.tileMatrixSetLabelPrefix

getset

The prefix to use for the tile matrix set labels.

For instance, setting "EPSG:4326:" as the prefix generates the list ["EPSG:4326:0", "EPSG:4326:1", "EPSG:4326:2", ...]. Only applicable when specifyTileMatrixSetLabels is false.

Definition at line 130 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ tileMatrixSetLabels

List<string> CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.tileMatrixSetLabels

getset

The manually specified tile matrix set labels.

Only applicable when specifyTileMatrixSetLabels is true.

Definition at line 165 of file CesiumWebMapTileServiceRasterOverlay.cs.

◆ tileWidth

int CesiumForUnity.CesiumWebMapTileServiceRasterOverlay.tileWidth

getset

The pixel width of the image tiles.

Definition at line 380 of file CesiumWebMapTileServiceRasterOverlay.cs.

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

Runtime/CesiumWebMapTileServiceRasterOverlay.cs

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddToTileset()

◆ RemoveFromTileset()

Property Documentation

◆ baseUrl

◆ format

◆ layer

◆ maximumLevel

◆ minimumLevel

◆ projection

◆ rectangleEast

◆ rectangleNorth

◆ rectangleSouth

◆ rectangleWest

◆ rootTilesX

◆ rootTilesY

◆ specifyTileMatrixSetLabels

◆ specifyTilingScheme

◆ specifyZoomLevels

◆ style

◆ tileHeight

◆ tileMatrixSetID

◆ tileMatrixSetLabelPrefix

◆ tileMatrixSetLabels

◆ tileWidth