Class: EllipsoidTerrainProvider

Members

creditCredit

Obtain the copyright statement displayed when the terrain provider is activated. Usually used for terrain sources. This function should not be called before EllipsoidTerrainProvider # ready returns true.

creditCredit

Obtain the copyright statement displayed when the terrain provider is activated. Usually used for terrain sources. This function should not be called before EllipsoidTerrainProvider # ready returns true.

errorEventEvent

Get the event triggered when the terrain provider encounters an asynchronous error. By subscribing to events, you will receive error notifications and may be able to recover from them. The event listener is passed an instance of TileProviderError.

errorEventEvent

Get the event triggered when the terrain provider encounters an asynchronous error. By subscribing to events, you will receive error notifications and may be able to recover from them. The event listener is passed an instance of TileProviderError.

hasVertexNormalsBoolean

Obtain a value indicating whether the requested tile contains vertex normals. This function should not be called before EllipsoidTerrainProvider # ready returns true.

hasVertexNormalsBoolean

Obtain a value indicating whether the requested tile contains vertex normals. This function should not be called before EllipsoidTerrainProvider # ready returns true.

hasWaterMaskBoolean

Gets whether the provider includes water mask data. The water mask indicates which areas of the Earth are water rather than land, so it can be rendered as a reflective surface with animated waves. This function should not be called before EllipsoidTerrainProvider#ready returns true.

hasWaterMaskBoolean

Gets whether the provider includes water mask data. The water mask indicates which areas of the Earth are water rather than land, so it can be rendered as a reflective surface with animated waves. This function should not be called before EllipsoidTerrainProvider#ready returns true.

isCreateSkirtBoolean

Gets or sets whether the terrain skirt is created for display. Default is true, false turns it off.

isCreateSkirtBoolean

Gets or sets whether the terrain skirt is created. The terrain skirt is used to avoid terrain cracks. Default is true (enabled), false turns it off.

isCreateSkirtBoolean

Gets or sets whether the terrain skirt is created for display. Default is true, false turns it off.

readyBoolean

Get a value indicating whether the provider can use it.

readyBoolean

Get a value indicating whether the provider can use it.

readonly readyPromisePromise.<Boolean>

Get the promise that parses to true when the provider is ready.

readonly readyPromisePromise.<Boolean>

Get the promise that parses to true when the provider is ready.

tilingSchemeGeographicTilingScheme

Obtain the tile scheme used by this provider. This function should not be called until EllipsoidTerrainProvider # ready returns true.

tilingSchemeGeographicTilingScheme

Obtain the tile scheme used by this provider. This function should not be called until EllipsoidTerrainProvider # ready returns true.

Methods

getLevelMaximumGeometricError(level){Number}

Obtain the maximum geometric error allowed for tiles at a given level.

Name	Type	Description
level	Number	To obtain the tile level with the maximum geometric error.

Returns:

Type	Description
Number	The maximum geometric error.

getTileDataAvailable(x, y, level){Boolean}

Determine if data for tiles can be loaded.

Name	Type	Description
x	Number	Request the X coordinate of the tile of the geometry.
y	Number	Request the Y coordinate of the tile of the geometry.
level	Number	Request the tile level of the geometry.

Returns:

Type	Description
Boolean	If not supported, undefined; otherwise, true or false.

requestTileGeometry(x, y, level, request){Promise.<TerrainData>|undefined}

Requests the geometry for the specified tile. This function should not be called before TerrainProvider#ready returns true. The results include terrain data and indicate that all sub-tiles are available.

Name	Type	Description
x	Number	Request the X coordinate of the tile of the geometry.
y	Number	Request the Y coordinate of the tile of the geometry.
level	Number	Request the tile level of the geometry.
request	Request	optional Request object. For internal use only.

Returns:

Type	Description
Promise.<TerrainData> | undefined	Promise for the requested geometry. If this method returns undefined instead of a promise, it indicates that there are already too many requests pending and the request will be retried later.