TerrainProvider

abstract external class TerrainProvider(source)

Provides terrain or other geometry for the surface of an ellipsoid. The surface geometry is organized into a pyramid of tiles according to a TilingScheme. This type describes an interface and is not intended to be instantiated directly.

See also

Inheritors

Constructors

Link copied to clipboard
constructor()

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles. This property may be undefined if availability information is not available.

Link copied to clipboard
abstract val credit: Credit

Gets the credit to display when this terrain provider is active. Typically this is used to credit the source of the terrain.

Link copied to clipboard
abstract val 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.

Link copied to clipboard

Gets a value indicating whether or not the requested tiles include vertex normals.

Link copied to clipboard
abstract val 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.

Link copied to clipboard

Gets the tiling scheme used by the provider.

Functions

Link copied to clipboard

Gets the maximum geometric error allowed in a tile at a given level.

Link copied to clipboard
abstract fun getTileDataAvailable(x: Double, y: Double, level: Int): Boolean?

Determines whether data for a tile is available to be loaded.

Link copied to clipboard
suspend fun loadTileDataAvailability(x: Double, y: Double, level: Int)

Makes sure we load availability data for a tile

Link copied to clipboard
abstract fun loadTileDataAvailabilityAsync(x: Double, y: Double, level: Int): Promise<Void>?
Link copied to clipboard
suspend fun requestTileGeometry(x: Double, y: Double, level: Int, request: Request? = definedExternally): TerrainData?

Requests the geometry for a given tile. The result must include terrain data and may optionally include a water mask and an indication of which child tiles are available.

Link copied to clipboard
abstract fun requestTileGeometryAsync(x: Double, y: Double, level: Int, request: Request? = definedExternally): Promise<TerrainData>?