VRTheWorldTerrainProvider

new Cesium.VRTheWorldTerrainProvider(options)
Core/VRTheWorldTerrainProvider.js 64

A TerrainProvider that produces terrain geometry by tessellating height maps retrieved from a VT MÄK VR-TheWorld server.
Name Type Description
options Object Object with the following properties:
Name Type Default Description
url Resource | String The URL of the VR-TheWorld TileMap.
ellipsoid Ellipsoid Ellipsoid.WGS84 optional The ellipsoid. If this parameter is not specified, the WGS84 ellipsoid is used.
credit Credit | String optional A credit for the data source, which is displayed on the canvas.
Example:
var terrainProvider = new Cesium.VRTheWorldTerrainProvider({
  url : 'https://www.vr-theworld.com/vr-theworld/tiles1.0.0/73/'
});
viewer.terrainProvider = terrainProvider;
See:

Members

credit : Credit
Core/VRTheWorldTerrainProvider.js 168

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 VRTheWorldTerrainProvider#ready returns true.

errorEvent : Event
Core/VRTheWorldTerrainProvider.js 156

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/VRTheWorldTerrainProvider.js 235

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

hasWaterMask : Boolean
Core/VRTheWorldTerrainProvider.js 223

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 VRTheWorldTerrainProvider#ready returns true.

ready : Boolean
Core/VRTheWorldTerrainProvider.js 197

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

readonlyreadyPromise : Promise.<Boolean>
Core/VRTheWorldTerrainProvider.js 209

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

tilingScheme : GeographicTilingScheme
Core/VRTheWorldTerrainProvider.js 180

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

Methods

getLevelMaximumGeometricError(level) → Number
Core/VRTheWorldTerrainProvider.js 296

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/VRTheWorldTerrainProvider.js 356

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.

loadTileDataAvailability(x, y, level) → undefined|Promise
Core/VRTheWorldTerrainProvider.js 368

Makes sure we load availability data for a tile
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 nothing need to be loaded or a Promise that resolves when all required tiles are loaded

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

Requests the geometry for a given tile. This function should not be called before VRTheWorldTerrainProvider#ready returns true. The result includes terrain data and indicates that all 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.