Cesium3DTilesTerrainProvider

To construct a Cesium3DTilesTerrainProvider, call [Cesium3DTilesTerrainProvider.fromIonAssetId] or [Cesium3DTilesTerrainProvider.fromUrl]. Do not call the constructor directly.

A TerrainProvider that accesses terrain data in a 3D Tiles format.

Parameters

options

An object describing initialization options

See also

Types

Link copied to clipboard
object Companion
Link copied to clipboard

Initialization options for the Cesium3DTilesTerrainProvider constructor

Properties

Link copied to clipboard
open override var availability: TileAvailability?

Gets an object that can be used to determine availability of terrain from this provider, such as at points and in rectangles.

Link copied to clipboard
open override var 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 var errorEvent: DefaultEvent

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
open override var hasVertexNormals: Boolean

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

Link copied to clipboard
open override var 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
open override var tilingScheme: TilingScheme

Gets the tiling scheme used by the provider.

Functions

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

Get 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): ERROR CLASS: Symbol not found for Promise<ERROR CLASS: Symbol not found for Void>??

Make 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?): ERROR CLASS: Symbol not found for Promise<cesium/engine/Cesium3DTilesTerrainData>??

Requests the geometry for a given tile. This function should not be called before Cesium3DTilesTerrainProvider.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.