Surface

The surface contains elevation sources and defines a surface upon which layers and overlays can be draped. The surface is used to represent the ground in a scene. It is comprised of a collection of elevation sources (ElevationSource) which are combined in the scene to generate the surface.

Since

200.1.0

Constructors

Link copied to clipboard
constructor()

Creates a surface object. Provides a surface on which layers may be draped or from which relative layers maybe offset. The most common use of the surface is to represent the ground in a scene. It is comprised of a collection of elevation sources ElevationSource which are combined in the scene to generate the surface. If the data from the elevation sources is spatially coincident it will use the elevation source order to determine which source to use.

Properties

Link copied to clipboard

Grid and color settings to render the background grid of this surface. The background grid is visible when no data is draped on the surface.

Link copied to clipboard

The exaggeration for the surface. The altitude values of the surface data are multiplied by the exaggeration value. The default value is 1.0, indicating no exaggeration.

Link copied to clipboard

The elevation sources for the surface. Elevation sources are an ordered collection of ElevationSource data that are combined to generate elevation values for the surface. The order of the elevation sources in the collection indicate which elevation has priority when the sources are spatially coincident. The collection is specific to a surface so you cannot reuse an elevation source collection coming from another Surface.

Link copied to clipboard

True if the surface is enabled, false otherwise. This value indicates if the surface is enabled and is rendered. If true, the surface's elevation sources are only used in the calculation of the surface if their ElevationSource.isEnabled is also true.

Link copied to clipboard

The name for the surface.

Link copied to clipboard

The type of navigation constraint of the surface. This property determines whether the camera altitude is affected by the elevation at the location of the camera. You can restrict the camera to stay above the ground or allow it to move below the surface. The default value is NavigationConstraint.StayAbove.

Link copied to clipboard

The opacity applied to the surface. The opacity value of all layers in the basemap, associated with this surface, and the Surface.backgroundGrid are multiplied by this opacity value. The value can be between 0 and 1.0, where 0 is transparent and 1.0 is solid or opaque.

Inherited properties

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

The load status.

Functions

Link copied to clipboard
suspend fun getElevation(point: Point): Result<Double>

Gets the elevation (in meters) for the specified location on the surface.

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.