CesiumForUnity.CesiumIonRasterOverlay Class Reference

A CesiumRasterOverlay that uses an IMAGERY asset from Cesium ion. More...

Inheritance diagram for CesiumForUnity.CesiumIonRasterOverlay:

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
long	ionAssetID [get, set]
	The ID of the Cesium ion asset to use.
string	ionAccessToken [get, set]
	The access token to use to access the Cesium ion resource.
CesiumIonServer	ionServer [get, set]
	The Cesium ion server from which this raster overlay is loaded.
string	assetOptions [get, set]
	Extra options to pass to Cesium ion when accessing the asset.
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 CesiumRasterOverlay that uses an IMAGERY asset from Cesium ion.

Definition at line 13 of file CesiumIonRasterOverlay.cs.

Member Function Documentation

AddToTileset()

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

protected

RemoveFromTileset()

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

protected

Property Documentation

assetOptions

string CesiumForUnity.CesiumIonRasterOverlay.assetOptions

getset

Extra options to pass to Cesium ion when accessing the asset.

This should be a JSON string.

Definition at line 88 of file CesiumIonRasterOverlay.cs.

ionAccessToken

string CesiumForUnity.CesiumIonRasterOverlay.ionAccessToken

getset

The access token to use to access the Cesium ion resource.

Definition at line 37 of file CesiumIonRasterOverlay.cs.

ionAssetID

long CesiumForUnity.CesiumIonRasterOverlay.ionAssetID

getset

The ID of the Cesium ion asset to use.

Definition at line 21 of file CesiumIonRasterOverlay.cs.

ionServer

CesiumIonServer CesiumForUnity.CesiumIonRasterOverlay.ionServer

getset

The Cesium ion server from which this raster overlay is loaded.

Definition at line 53 of file CesiumIonRasterOverlay.cs.

---

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

• Runtime/CesiumIonRasterOverlay.cs