CesiumTerrainProvider

Members

credit :Credit

Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain. This function should not be called before CesiumTerrainProvider#ready returns true.

errorEvent :Event

Gets an event that is raised when the terrain provider encounters an asynchronous error. By subscribing to the event, you will be notified of the error and can potentially recover from it. Event listeners are passed an instance of TileProviderError.

ready :Boolean

Gets a value indicating whether or not the provider is ready for use.

tilingScheme :GeographicTilingScheme

Gets the tiling scheme used by this provider. This function should not be called before CesiumTerrainProvider#ready returns true.

Methods

getLevelMaximumGeometricError

Gets the maximum geometric error allowed in a tile at a given level.

Parameters:

Name	Type	Description
level	Number	The tile level for which to get the maximum geometric error.

Returns:

Number The maximum geometric error.

hasWaterMask

Gets a value indicating whether or not the provider includes a water mask. The water mask indicates which areas of the globe are water rather than land, so they can be rendered as a reflective surface with animated waves.

Throws:

DeveloperError : This function must not be called before CesiumTerrainProvider#ready returns true.

Returns:

Boolean True if the provider has a water mask; otherwise, false.

requestTileGeometry

Requests the geometry for a given tile. This function should not be called before CesiumTerrainProvider#ready returns true. The result must include terrain data and may optionally include a water mask and an indication of which child tiles are available.

Parameters:

Name	Type	Argument	Default	Description
x	Number			The X coordinate of the tile for which to request geometry.
y	Number			The Y coordinate of the tile for which to request geometry.
level	Number			The level of the tile for which to request geometry.
throttleRequests	Boolean	<optional>	true	True if the number of simultaneous requests should be limited, or false if the request should be initiated regardless of the number of requests already in progress.

Throws:

DeveloperError : This function must not be called before CesiumTerrainProvider#ready returns true.

Returns:

Promise | TerrainData A promise for the requested geometry. If this method returns undefined instead of a promise, it is an indication that too many requests are already pending and the request will be retried later.