CesiumTerrainProvider

new Cesium.CesiumTerrainProvider(options)
Core/CesiumTerrainProvider.js 90

A TerrainProvider that accesses terrain data in a Cesium terrain format. The format is described on the Cesium wiki.
Name Type Description
options Object Object with the following properties:
Name Type Default Description
url Resource | String | Promise.<Resource> | Promise.<String> The URL of the Cesium terrain server.
requestVertexNormals Boolean false optional Flag that indicates if the client should request additional lighting information from the server, in the form of per vertex normals if available.
requestWaterMask Boolean false optional Flag that indicates if the client should request per tile water masks from the server, if available.
ellipsoid Ellipsoid optional The ellipsoid. If not specified, the WGS84 ellipsoid is used.
credit Credit | String optional A credit for the data source, which is displayed on the canvas.
Example:
// Create Arctic DEM terrain with normals.
var viewer = new Cesium.Viewer('cesiumContainer', {
    terrainProvider : new Cesium.CesiumTerrainProvider({
        url : Cesium.IonResource.fromAssetId(3956),
        requestVertexNormals : true
    });
});
See:

Members

availability : TileAvailability
Core/CesiumTerrainProvider.js 801

Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles. This function should not be called before CesiumTerrainProvider#ready returns true. This property may be undefined if availability information is not available.

credit : Credit
Core/CesiumTerrainProvider.js 673

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
Core/CesiumTerrainProvider.js 661

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.

hasVertexNormals : Boolean
Core/CesiumTerrainProvider.js 754

Gets a value indicating whether or not the requested tiles include vertex normals. This function should not be called before CesiumTerrainProvider#ready returns true.

hasWaterMask : Boolean
Core/CesiumTerrainProvider.js 735

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. This function should not be called before CesiumTerrainProvider#ready returns true.

ready : Boolean
Core/CesiumTerrainProvider.js 708

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

readonlyreadyPromise : Promise.<Boolean>
Core/CesiumTerrainProvider.js 720

Gets a promise that resolves to true when the provider is ready for use.

requestVertexNormals : Boolean
Core/CesiumTerrainProvider.js 774

Boolean flag that indicates if the client should request vertex normals from the server. Vertex normals data is appended to the standard tile mesh data only if the client requests the vertex normals and if the server provides vertex normals.

requestWaterMask : Boolean
Core/CesiumTerrainProvider.js 787

Boolean flag that indicates if the client should request a watermask from the server. Watermask data is appended to the standard tile mesh data only if the client requests the watermask and if the server provides a watermask.

tilingScheme : GeographicTilingScheme
Core/CesiumTerrainProvider.js 691

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

Methods

getLevelMaximumGeometricError(level) → Number
Core/CesiumTerrainProvider.js 819

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.

getTileDataAvailable(x, y, level) → Boolean
Core/CesiumTerrainProvider.js 831

Determines whether data for a tile is available to be loaded.
Name Type 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.
Returns:
Undefined if not supported, otherwise true or false.

requestTileGeometry(x, y, level, request) → Promise.<TerrainData>|undefined
Core/CesiumTerrainProvider.js 582

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 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.
request Request optional The request object. Intended for internal use only.
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: