RasterElevationSource

An elevation source based on raster elevation files. A raster elevation source helps visualize maps and layers in 3D by providing a surface that layers may be draped or offset from. You can create a raster elevation source from a collection of raster elevation files, such as Digital Terrain Elevation Data (DTED) format files. See Raster To DTED for more information about creating raster elevation files based on the DTED tiling scheme.

To utilize an elevation source in a scene's surface, add it to the scene's Surface.elevationSources collection.

Since

200.1.0

Constructors

Link copied to clipboard
constructor(filePaths: Iterable<String> = mutableListOf())

Creates a raster elevation source using a collection of file paths to raster elevation files.

Properties

Link copied to clipboard

The collection of files paths that are used to create the raster elevation source.

Link copied to clipboard

The extent of the elevation source.

Inherited properties

Link copied to clipboard
var id: String

The unique identifying string for the ElevationSource, as specified in a scene. The ID is used by other parts of the API to reference a specific ElevationSource. If not provided, a unique ID is automatically assigned to each ElevationSource upon creation. When changing the ID, ensure the value remains unique so the ElevationSource can be reliably located by ID.

Link copied to clipboard

True if the elevation source participates in the generation of the Surface, false otherwise.

Link copied to clipboard
open override val loadStatus: StateFlow<LoadStatus>

The load status.

Link copied to clipboard

The name of the elevation source.

Inherited functions

Link copied to clipboard
open override fun cancelLoad()

Cancels loading metadata for the Loadable object.

Link copied to clipboard
open suspend override fun load(): Result<Unit>

Loads the metadata for the object.

Link copied to clipboard
open suspend override fun retryLoad(): Result<Unit>

Loads or retries loading metadata for the object.