kotlin-cesium-engine/cesium.engine/CustomDataSource

CustomDataSource

external class CustomDataSource(var name: String = definedExternally)(source)

A DataSource implementation which can be used to manually manage a group of entities.

const dataSource = new CustomDataSource('myData');

const entity = dataSource.entities.add({
   position : Cartesian3.fromDegrees(1, 2, 0),
   billboard : {
       image : 'image.png'
   }
});

viewer.dataSources.add(dataSource);

Constructors

CustomDataSource

constructor(name: String = definedExternally)

Properties

changedEvent

var changedEvent: DefaultEvent

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

clock

var clock: DataSourceClock

Gets or sets the clock for this instance.

clustering

var clustering: EntityCluster

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

entities

var entities: EntityCollection

Gets the collection of Entity instances.

errorEvent

var errorEvent: DefaultEvent

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

isLoading

var isLoading: Boolean

Gets or sets whether the data source is currently loading data.

loadingEvent

var loadingEvent: DefaultEvent

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

name

var name: String

A human-readable name for this instance.

show

var show: Boolean

Gets whether or not this data source should be displayed.

Functions

update

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.

CustomDataSource

See also

Constructors

Properties

Functions