new EllipsoidTerrainProvider(options)
A very simple
TerrainProvider that produces geometry by tessellating an ellipsoidal
surface.
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object |
optional
Object with the following properties:
|
See:
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
EllipsoidTerrainProvider#readyreturns 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. -
hasVertexNormals :Boolean
-
Gets a value indicating whether or not the requested tiles include vertex normals. This function should not be called before
EllipsoidTerrainProvider#readyreturns true. -
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. This function should not be called before
EllipsoidTerrainProvider#readyreturns true. -
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
EllipsoidTerrainProvider#readyreturns true.
Methods
-
getLevelMaximumGeometricError(level) → Number
-
Gets the maximum geometric error allowed in a tile at a given level.
Name Type Description levelNumber The tile level for which to get the maximum geometric error. Returns:
The maximum geometric error. -
getTileDataAvailable(x, y, level) → Boolean
-
Determines whether data for a tile is available to be loaded.
Name Type Description xNumber The X coordinate of the tile for which to request geometry. yNumber The Y coordinate of the tile for which to request geometry. levelNumber The level of the tile for which to request geometry. Returns:
Undefined if not supported, otherwise true or false. -
requestTileGeometry(x, y, level, throttleRequests) → Promise|TerrainData
-
Requests the geometry for a given tile. This function should not be called before
TerrainProvider#readyreturns true. The result includes terrain data and indicates that all child tiles are available.Name Type Default Description xNumber The X coordinate of the tile for which to request geometry. yNumber The Y coordinate of the tile for which to request geometry. levelNumber The level of the tile for which to request geometry. throttleRequestsBoolean trueoptional 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.