main.cesium.GoogleEarthEnterpriseTerrainProvider.kt Maven / Gradle / Ivy
// Automatically generated - do not modify!
@file:Suppress(
"VAR_OVERRIDDEN_BY_VAL",
"VAR_TYPE_MISMATCH_ON_OVERRIDE",
"NON_EXTERNAL_DECLARATION_IN_INAPPROPRIATE_FILE",
)
package cesium
/**
* Provides tiled terrain using the Google Earth Enterprise REST API.
* ```
* var geeMetadata = new GoogleEarthEnterpriseMetadata('http://www.earthenterprise.org/3d');
* var gee = new GoogleEarthEnterpriseTerrainProvider({
* metadata : geeMetadata
* });
* ```
* @see Online Documentation
*/
@JsName("\$cesium__GoogleEarthEnterpriseTerrainProvider")
external class GoogleEarthEnterpriseTerrainProvider(options: ConstructorOptions) : TerrainProvider {
/**
* @property [url] The url of the Google Earth Enterprise server hosting the imagery.
* @property [metadata] A metadata object that can be used to share metadata requests with a GoogleEarthEnterpriseImageryProvider.
* @property [ellipsoid] The ellipsoid. If not specified, the WGS84 ellipsoid is used.
* @property [credit] A credit for the data source, which is displayed on the canvas.
*/
interface ConstructorOptions {
var url: Resource
var metadata: GoogleEarthEnterpriseMetadata
var ellipsoid: Ellipsoid?
var credit: Credit?
}
/**
* Gets the name of the Google Earth Enterprise server url hosting the imagery.
* @see Online Documentation
*/
val url: String
/**
* Gets the proxy used by this provider.
* @see Online Documentation
*/
val proxy: Proxy
/**
* Gets the tiling scheme used by this provider. This function should
* not be called before [GoogleEarthEnterpriseTerrainProvider.ready] returns true.
* @see Online Documentation
*/
override val tilingScheme: TilingScheme
/**
* 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].
* @see Online Documentation
*/
override val errorEvent: Event
/**
* Gets a value indicating whether or not the provider is ready for use.
* @see Online Documentation
*/
override val ready: Boolean
/**
* Gets a promise that resolves to true when the provider is ready for use.
* @see Online Documentation
*/
override val readyPromise: kotlin.js.Promise
/**
* 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 [GoogleEarthEnterpriseTerrainProvider.ready] returns true.
* @see Online Documentation
*/
override val credit: Credit
/**
* 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 [GoogleEarthEnterpriseTerrainProvider.ready] returns true.
* @see Online Documentation
*/
override val hasWaterMask: Boolean
/**
* Gets a value indicating whether or not the requested tiles include vertex normals.
* This function should not be called before [GoogleEarthEnterpriseTerrainProvider.ready] returns true.
* @see Online Documentation
*/
override val hasVertexNormals: Boolean
/**
* Gets an object that can be used to determine availability of terrain from this provider, such as
* at points and in rectangles. This function should not be called before
* [GoogleEarthEnterpriseTerrainProvider.ready] returns true. This property may be undefined if availability
* information is not available.
* @see Online Documentation
*/
override val availability: TileAvailability
/**
* Requests the geometry for a given tile. This function should not be called before
* [GoogleEarthEnterpriseTerrainProvider.ready] returns true. The result must include terrain data and
* may optionally include a water mask and an indication of which child tiles are available.
* @param [x] The X coordinate of the tile for which to request geometry.
* @param [y] The Y coordinate of the tile for which to request geometry.
* @param [level] The level of the tile for which to request geometry.
* @param [request] The request object. Intended for internal use only.
* @return 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.
* @see Online Documentation
*/
override fun requestTileGeometry(
x: Double,
y: Double,
level: Int,
request: Request?,
): kotlin.js.Promise?
/**
* Gets the maximum geometric error allowed in a tile at a given level.
* @param [level] The tile level for which to get the maximum geometric error.
* @return The maximum geometric error.
* @see Online Documentation
*/
override fun getLevelMaximumGeometricError(level: Int): Double
/**
* Determines whether data for a tile is available to be loaded.
* @param [x] The X coordinate of the tile for which to request geometry.
* @param [y] The Y coordinate of the tile for which to request geometry.
* @param [level] The level of the tile for which to request geometry.
* @return Undefined if not supported, otherwise true or false.
* @see Online Documentation
*/
override fun getTileDataAvailable(
x: Double,
y: Double,
level: Int,
): Boolean?
/**
* Makes sure we load availability data for a tile
* @param [x] The X coordinate of the tile for which to request geometry.
* @param [y] The Y coordinate of the tile for which to request geometry.
* @param [level] The level of the tile for which to request geometry.
* @return Undefined if nothing need to be loaded or a Promise that resolves when all required tiles are loaded
* @see Online Documentation
*/
override fun loadTileDataAvailability(
x: Double,
y: Double,
level: Int,
): kotlin.js.Promise?
}