Cesium for Unity 1.15.2
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Properties | Events | List of all members
CesiumForUnity.CesiumRasterOverlay Class Referenceabstract

A pyramid of 2D images - sometimes terabytes or more in size - that can be draped over a Cesium3DTileset. More...

Inheritance diagram for CesiumForUnity.CesiumRasterOverlay:
CesiumForUnity.CesiumBingMapsRasterOverlay CesiumForUnity.CesiumDebugColorizeTilesRasterOverlay CesiumForUnity.CesiumIonRasterOverlay CesiumForUnity.CesiumPolygonRasterOverlay CesiumForUnity.CesiumTileMapServiceRasterOverlay CesiumForUnity.CesiumWebMapServiceRasterOverlay CesiumForUnity.CesiumWebMapTileServiceRasterOverlay

Public Member Functions

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.
 

Protected Member Functions

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 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.
 

Events

static RasterOverlayLoadFailureDelegate OnCesiumRasterOverlayLoadFailure
 An event that is raised when the raster overlay encounters an error that prevents it from loading.
 

Detailed Description

A pyramid of 2D images - sometimes terabytes or more in size - that can be draped over a Cesium3DTileset.

Definition at line 11 of file CesiumRasterOverlay.cs.

Member Function Documentation

◆ AddToTileset() [1/2]

void CesiumForUnity.CesiumRasterOverlay.AddToTileset ( )
inline

Adds this raster overlay to the Cesium3DTileset on the same game object.

If the overlay is already added or if the game object does not have a Cesium3DTileset, this method does nothing.

Definition at line 171 of file CesiumRasterOverlay.cs.

◆ AddToTileset() [2/2]

void CesiumForUnity.CesiumRasterOverlay.AddToTileset ( Cesium3DTileset tileset)
abstractprotected

When implemented in a derived class, adds the raster overlay to the given tileset.

Parameters
tilesetThe tileset.

◆ RasterOverlayLoadFailureDelegate()

delegate void CesiumForUnity.CesiumRasterOverlay.RasterOverlayLoadFailureDelegate ( CesiumRasterOverlayLoadFailureDetails details)

Encapsulates a method that receives details of a raster overlay load failure.

Parameters
detailsThe details of the load failure.

◆ Refresh()

void CesiumForUnity.CesiumRasterOverlay.Refresh ( )
inline

Refreshes this overlay by calling RemoveFromTileset followed by AddToTileset.

If the game object does not have a Cesium3DTileset, this method does nothing.

Definition at line 204 of file CesiumRasterOverlay.cs.

◆ RemoveFromTileset() [1/2]

void CesiumForUnity.CesiumRasterOverlay.RemoveFromTileset ( )
inline

Removes this raster overlay from the Cesium3DTileset on the same game object.

If the overlay is not yet added or if the game object does not have a Cesium3DTileset, this method does nothing.

Definition at line 190 of file CesiumRasterOverlay.cs.

◆ RemoveFromTileset() [2/2]

void CesiumForUnity.CesiumRasterOverlay.RemoveFromTileset ( Cesium3DTileset tileset)
abstractprotected

When implemented in a derived class, removes the raster overlay from the given tileset.

Parameters
tilesetThe tileset.

Property Documentation

◆ materialKey

string CesiumForUnity.CesiumRasterOverlay.materialKey
getset

The key to use to match this overlay to the corresponding parameters in the tileset's material.

In the tileset's materials, an overlay requires parameters for its texture, texture coordinate index, and translation and scale. Overlays must specify a string key to match with the correct parameters. The format of these parameters is as follows.

  • Overlay Texture: _overlayTexture_KEY
  • Overlay Texture Coordinate Index: _overlayTextureCoordinateIndex_KEY
  • Overlay Translation and Scale: _overlayTranslationScale_KEY

Material keys are useful for specifying the order of the raster overlays, or distinguishing them for overlay-specific effects.

Definition at line 53 of file CesiumRasterOverlay.cs.

◆ maximumScreenSpaceError

float CesiumForUnity.CesiumRasterOverlay.maximumScreenSpaceError
getset

The maximum number of pixels of error when rendering this overlay.

This is used to select an appropriate level-of-detail.

When this property has its default value, 2.0, it means that raster overlay images will be sized so that, when zoomed in closest, a single pixel in the raster overlay maps to approximately 2x2 pixels on the screen.

Definition at line 92 of file CesiumRasterOverlay.cs.

◆ maximumSimultaneousTileLoads

int CesiumForUnity.CesiumRasterOverlay.maximumSimultaneousTileLoads
getset

The maximum number of overlay tiles that may simultaneously be in the process of loading.

Definition at line 130 of file CesiumRasterOverlay.cs.

◆ maximumTextureSize

int CesiumForUnity.CesiumRasterOverlay.maximumTextureSize
getset

The maximum texel size of raster overlay textures, in either direction.

Images created by this overlay will be no more than this number of texels in either direction.This may result in reduced raster overlay detail in some cases.

Definition at line 113 of file CesiumRasterOverlay.cs.

◆ showCreditsOnScreen

bool CesiumForUnity.CesiumRasterOverlay.showCreditsOnScreen
getset

Whether or not to force this raster overlay's credits to be shown on the main screen.

If false, the credits are usually only shown on a "Data Attribution" popup.

Definition at line 70 of file CesiumRasterOverlay.cs.

◆ subTileCacheBytes

long CesiumForUnity.CesiumRasterOverlay.subTileCacheBytes
getset

The maximum number of bytes to use to cache sub-tiles in memory.

This is used by provider types that have an underlying tiling scheme that may not align with the tiling scheme of the geometry tiles on which the raster overlay tiles are draped. Because a single sub-tile may overlap multiple geometry tiles, it is useful to cache loaded sub-tiles in memory in case they're needed again soon. This property controls the maximum size of that cache.

Definition at line 154 of file CesiumRasterOverlay.cs.

Event Documentation

◆ OnCesiumRasterOverlayLoadFailure

RasterOverlayLoadFailureDelegate CesiumForUnity.CesiumRasterOverlay.OnCesiumRasterOverlayLoadFailure
static

An event that is raised when the raster overlay encounters an error that prevents it from loading.

Definition at line 24 of file CesiumRasterOverlay.cs.

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