kotlin-cesium-engine/cesium.engine/CustomHeightmapTerrainProvider

CustomHeightmapTerrainProvider

external class CustomHeightmapTerrainProvider(options: CustomHeightmapTerrainProvider.ConstructorOptions) : TerrainProvider(source)

A simple TerrainProvider that gets height values from a callback function. It can be used for procedurally generated terrain or as a way to load custom heightmap data without creating a subclass of TerrainProvider.

There are some limitations such as no water mask, no vertex normals, and no availability, so a full-fledged TerrainProvider subclass is better suited for these more sophisticated use cases.

const viewer = new Viewer("cesiumContainer", {
  terrainProvider: new CustomHeightmapTerrainProvider({
    width: 32,
    height: 32,
    callback: function (x, y, level) {
      return new Float32Array(32 * 32); // all zeros
    },
  }),
});

Constructors

CustomHeightmapTerrainProvider

constructor(options: CustomHeightmapTerrainProvider.ConstructorOptions)

Types

ConstructorOptions

interface ConstructorOptions

Properties

availability

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.

credit

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.

errorEvent

open override val 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.

hasVertexNormals

open override val hasVertexNormals: Boolean

Gets a value indicating whether or not the requested tiles include vertex normals. Vertex normals are not supported by CustomHeightmapTerrainProvider, so the return value will always be false.

hasWaterMask

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. Water mask is not supported by CustomHeightmapTerrainProvider, so the return value will always be false.

height

val height: Boolean

Gets the number of rows per heightmap tile.

tilingScheme

open override val tilingScheme: TilingScheme

Gets the tiling scheme used by this provider.

width

val width: Boolean

Gets the number of columns per heightmap tile.

Functions

getLevelMaximumGeometricError

open override fun getLevelMaximumGeometricError(level: Int): Double

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

getTileDataAvailable

open override fun getTileDataAvailable(x: Double, y: Double, level: Int): Boolean?

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

loadTileDataAvailability

suspend fun loadTileDataAvailability(x: Double, y: Double, level: Int)

Makes sure we load availability data for a tile

loadTileDataAvailabilityAsync

open override fun loadTileDataAvailabilityAsync(x: Double, y: Double, level: Int): Promise<Void>?

Makes sure we load availability data for a tile

requestTileGeometry

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.

requestTileGeometryAsync

open override fun requestTileGeometryAsync(x: Double, y: Double, level: Int, request: Request?): Promise<TerrainData>?

Requests the geometry for a given tile. The result includes terrain data and indicates that all child tiles are available.

CustomHeightmapTerrainProvider

See also

Constructors

Types

Properties

Functions