BuildingSublayer

A sublayer of a BuildingSceneLayer. It represents a building component or group of components.

Since

300.0.0

Inheritors

Properties

Link copied to clipboard

The building discipline (such as Architectural, Mechanical, or Structural) that this sublayer represents.

Link copied to clipboard

The name that identifies the building entity (such as Floors, Ceiling, Casework) that this sublayer represents. This may be used to define behavior or visualization properties specific to a given building component.

Link copied to clipboard

The opacity of this sublayer. The valid opacity values range from 0.0 (fully transparent) to 1.0 (fully opaque).

Link copied to clipboard

The sublayer's layer ID as defined by the scene service.

Inherited properties

Link copied to clipboard
open override val canChangeVisibility: Boolean

A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.

Link copied to clipboard
open override var isVisible: Boolean

The layer content's visibility. The layer content visibility. Will return false if an error occurs.

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

The load status.

Link copied to clipboard
open override val name: String

The layer content's name. The layer content name.

Link copied to clipboard
open override var showInLegend: Boolean

A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.

Link copied to clipboard
open override val subLayerContents: StateFlow<List<LayerContent>>

The sub layer contents of a layer content.

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 fetchLegendInfos(): Result<List<LegendInfo>>

Fetches the list of legend info.

Link copied to clipboard
open override fun isVisibleAtScale(scale: Double): Boolean

Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.

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.