GoogleEarthEnterpriseTerrainProvider

To construct a GoogleEarthEnterpriseTerrainProvider, call {@link GoogleEarthEnterpriseTerrainProvider.fromMetadata}. Do not call the constructor directly.

Provides tiled terrain using the Google Earth Enterprise REST API.

const geeMetadata = await GoogleEarthEnterpriseMetadata.fromUrl("http://www.example.com");
const gee = GoogleEarthEnterpriseTerrainProvider.fromMetadata(geeMetadata);

Parameters

options

An object describing initialization options

See also

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Initialization options for GoogleEarthEnterpriseTerrainProvider constructor

Properties

Link copied to clipboard
open override val availability: TileAvailability

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
open override 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
open override val errorEvent: DefaultEvent

Gets an event that is raised when the imagery 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
open override val hasVertexNormals: Boolean

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

Link copied to clipboard
open override 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 proxy used by this provider.

Link copied to clipboard
open override val tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

Link copied to clipboard
val url: String

Gets the name of the Google Earth Enterprise server url hosting the imagery.

Functions

Link copied to clipboard
open override fun getLevelMaximumGeometricError(level: Int): Double

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

Link copied to clipboard
open override 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
open override fun loadTileDataAvailabilityAsync(x: Double, y: Double, level: Int): Void

Makes sure we load availability data for a tile

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
open override fun requestTileGeometryAsync(x: Double, y: Double, level: Int, request: Request?): Promise<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.