A raster overlay that loads tiles from a templated URL. More...

Inheritance diagram for CesiumForUnity.CesiumUrlTemplateRasterOverlay:

Classes
class	HeaderEntry
	An HTTP header name paired with its specified value. More...

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	templateUrl `[get, set]`
	The URL containing template parameters that will be substituted when loading tiles.

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

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

int	rootTilesX `[get, set]`
	If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the X direction.

int	rootTilesY `[get, set]`
	If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the Y direction.

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.

int	minimumLevel `[get, set]`
	Minimum zoom level.

int	maximumLevel `[get, set]`
	Maximum zoom level.

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

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

List< HeaderEntry >	requestHeaders `[get, set]`
	HTTP headers to be attached to each request made for this raster overlay.

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 loads tiles from a templated URL.

Definition at line 30 of file CesiumUrlTemplateRasterOverlay.cs.

Member Function Documentation

◆ AddToTileset()

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

protected

◆ RemoveFromTileset()

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

protected

Property Documentation

◆ maximumLevel

int CesiumForUnity.CesiumUrlTemplateRasterOverlay.maximumLevel

getset

Maximum zoom level.

Definition at line 255 of file CesiumUrlTemplateRasterOverlay.cs.

◆ minimumLevel

int CesiumForUnity.CesiumUrlTemplateRasterOverlay.minimumLevel

getset

Minimum zoom level.

Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems.

Definition at line 238 of file CesiumUrlTemplateRasterOverlay.cs.

◆ projection

CesiumUrlTemplateRasterOverlayProjection CesiumForUnity.CesiumUrlTemplateRasterOverlay.projection

getset

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

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

Definition at line 85 of file CesiumUrlTemplateRasterOverlay.cs.

◆ rectangleEast

double CesiumForUnity.CesiumUrlTemplateRasterOverlay.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 "Specify Tiling Scheme" is set to true.

Definition at line 198 of file CesiumUrlTemplateRasterOverlay.cs.

◆ rectangleNorth

double CesiumForUnity.CesiumUrlTemplateRasterOverlay.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 "Specify Tiling Scheme" is set to true.

Definition at line 217 of file CesiumUrlTemplateRasterOverlay.cs.

◆ rectangleSouth

double CesiumForUnity.CesiumUrlTemplateRasterOverlay.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 "Specify Tiling Scheme" is set to true.

Definition at line 179 of file CesiumUrlTemplateRasterOverlay.cs.

◆ rectangleWest

double CesiumForUnity.CesiumUrlTemplateRasterOverlay.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 "Specify Tiling Scheme" is set to true.

Definition at line 160 of file CesiumUrlTemplateRasterOverlay.cs.

◆ requestHeaders

List<HeaderEntry> CesiumForUnity.CesiumUrlTemplateRasterOverlay.requestHeaders

getset

HTTP headers to be attached to each request made for this raster overlay.

Definition at line 305 of file CesiumUrlTemplateRasterOverlay.cs.

◆ rootTilesX

int CesiumForUnity.CesiumUrlTemplateRasterOverlay.rootTilesX

getset

If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the X direction.

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 122 of file CesiumUrlTemplateRasterOverlay.cs.

◆ rootTilesY

int CesiumForUnity.CesiumUrlTemplateRasterOverlay.rootTilesY

getset

If specified, this determines the number of tiles at the root of the quadtree tiling scheme in the Y direction.

Only applicable if "Specify Tiling Scheme" is set to true.

Definition at line 141 of file CesiumUrlTemplateRasterOverlay.cs.

◆ specifyTilingScheme

bool CesiumForUnity.CesiumUrlTemplateRasterOverlay.specifyTilingScheme

getset

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

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

Definition at line 103 of file CesiumUrlTemplateRasterOverlay.cs.

◆ templateUrl

string CesiumForUnity.CesiumUrlTemplateRasterOverlay.templateUrl

getset

The URL containing template parameters that will be substituted when loading tiles.

The following template parameters are supported in url:

{x} - The tile X coordinate in the tiling scheme, where 0 is the westernmost tile.
{y} - The tile Y coordinate in the tiling scheme, where 0 is the nothernmost tile.
{z} - The level of the tile in the tiling scheme, where 0 is the root of the quadtree pyramid.
{reverseX} - The tile X coordinate in the tiling scheme, where 0 is the easternmost tile.
{reverseY} - The tile Y coordinate in the tiling scheme, where 0 is the southernmost tile.
{reverseZ} - The tile Z coordinate in the tiling scheme, where 0 is equivalent to urlTemplateOptions.maximumLevel.
{westDegrees} - The western edge of the tile in geodetic degrees.
{southDegrees} - The southern edge of the tile in geodetic degrees.
{eastDegrees} - The eastern edge of the tile in geodetic degrees.
{northDegrees} - The northern edge of the tile in geodetic degrees.
{minimumX} - The minimum X coordinate of the tile's projected coordinates.
{minimumY} - The minimum Y coordinate of the tile's projected coordinates.
{maximumX} - The maximum X coordinate of the tile's projected coordinates.
{maximumY} - The maximum Y coordinate of the tile's projected coordinates.
{width} - The width of each tile in pixels.
{height} - The height of each tile in pixels.

Definition at line 67 of file CesiumUrlTemplateRasterOverlay.cs.

◆ tileHeight

int CesiumForUnity.CesiumUrlTemplateRasterOverlay.tileHeight

getset

The pixel height of the image tiles.

Definition at line 289 of file CesiumUrlTemplateRasterOverlay.cs.

◆ tileWidth

int CesiumForUnity.CesiumUrlTemplateRasterOverlay.tileWidth

getset

The pixel width of the image tiles.

Definition at line 272 of file CesiumUrlTemplateRasterOverlay.cs.

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

Runtime/CesiumUrlTemplateRasterOverlay.cs

Classes

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ AddToTileset()

◆ RemoveFromTileset()

Property Documentation

◆ maximumLevel

◆ minimumLevel

◆ projection

◆ rectangleEast

◆ rectangleNorth

◆ rectangleSouth

◆ rectangleWest

◆ requestHeaders

◆ rootTilesX

◆ rootTilesY

◆ specifyTilingScheme

◆ templateUrl

◆ tileHeight

◆ tileWidth