kotlin-cesium-engine/cesium.engine/CzmlDataSource

CzmlDataSource

open external class CzmlDataSource(var name: String = definedExternally)(source)

A DataSource which processes CZML.

Constructors

CzmlDataSource

constructor(name: String = definedExternally)

Types

Companion

external object Companion

Properties

changedEvent

external var changedEvent: DefaultEvent

Gets an event that will be raised when the underlying data changes.

clock

external var clock: DataSourceClock

Gets the clock settings defined by the loaded CZML. If no clock is explicitly defined in the CZML, the combined availability of all objects is returned. If only static data exists, this value is undefined.

clustering

external var clustering: EntityCluster

Gets or sets the clustering options for this data source. This object can be shared between multiple data sources.

credit

external var credit: Credit

Gets the credit that will be displayed for the data source

entities

external var entities: EntityCollection

Gets the collection of Entity instances.

errorEvent

external var errorEvent: DefaultEvent

Gets an event that will be raised if an error is encountered during processing.

isLoading

external var isLoading: Boolean

Gets a value indicating if the data source is currently loading data.

loadingEvent

external var loadingEvent: DefaultEvent

Gets an event that will be raised when the data source either starts or stops loading.

name

external var name: String

An optional name for the data source. This value will be overwritten if a loaded document contains a name.

show

external var show: Boolean

Gets whether or not this data source should be displayed.

Functions

load

suspend external fun load(czml: Resource, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

Loads the provided url or CZML object, replacing any existing data.

suspend external fun load(czml: JsAny, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

suspend external fun load(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

loadAsync

external fun loadAsync(czml: Resource, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>

external fun loadAsync(czml: JsAny, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>

external fun loadAsync(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>

process

suspend external fun process(czml: Resource, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

Processes the provided url or CZML object without clearing any existing data.

suspend external fun process(czml: JsAny, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

suspend external fun process(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): CzmlDataSource

processAsync

external fun processAsync(czml: Resource, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>

external fun processAsync(czml: JsAny, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>

external fun processAsync(czml: String, options: CzmlDataSource.Companion.LoadOptions? = definedExternally): Promise<CzmlDataSource>

update

external fun update(time: JulianDate): Boolean

Updates the data source to the provided time. This function is optional and is not required to be implemented. It is provided for data sources which retrieve data based on the current animation time or scene state. If implemented, update will be called by DataSourceDisplay once a frame.

CzmlDataSource

See also

Constructors

Types

Properties

Functions