CesiumTerrainProvider

new CesiumTerrainProvider()

A TerrainProvider that access terrain data in a Cesium terrain format. The format is described on the Cesium wiki.
Name Type Description
options.url String The URL of the Cesium terrain server.
options.proxy Proxy optional A proxy to use for requests. This object is expected to have a getURL function which returns the proxied URL, if needed.
options.credit Credit | String optional A credit for the data source, which is displayed on the canvas.
See:
Source: Core/CesiumTerrainProvider.js, line 58

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.
Source: Core/CesiumTerrainProvider.js, line 407

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.
Source: Core/CesiumTerrainProvider.js, line 395

ready :Boolean

Gets a value indicating whether or not the provider is ready for use.
Source: Core/CesiumTerrainProvider.js, line 442

tilingScheme :GeographicTilingScheme

Gets the tiling scheme used by this provider. This function should not be called before CesiumTerrainProvider#ready returns true.
Source: Core/CesiumTerrainProvider.js, line 425

Methods

getLevelMaximumGeometricError(level) → Number

Gets the maximum geometric error allowed in a tile at a given level.
Name Type Description
level Number The tile level for which to get the maximum geometric error.
Returns:
The maximum geometric error.
Source: Core/CesiumTerrainProvider.js, line 457

hasWaterMask() → Boolean

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.
Returns:
True if the provider has a water mask; otherwise, false.
Throws:
Source: Core/CesiumTerrainProvider.js, line 473

requestTileGeometry(x, y, level, throttleRequests) → Promise|TerrainData

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.
Name Type 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 true optional 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.
Returns:
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.
Throws:
Source: Core/CesiumTerrainProvider.js, line 341