org.cesiumjs.cs.datasources

Class CustomDataSource

java.lang.Object

org.cesiumjs.cs.datasources.CustomDataSource

All Implemented Interfaces:

DataSource

@JsType(isNative=true,
        namespace="Cesium",
        name="CustomDataSource")
public class CustomDataSource
extends Object
implements DataSource

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Event	changedEvent Gets an event that will be raised when the underlying data changes.
DataSourceClock	clock Gets or sets the clock for this instance.
EntityCluster	clustering Gets or sets the clustering options for this data source.
EntityCollection	entities Gets the collection of Entity instances.
Event	errorEvent Gets an event that will be raised if an error is encountered during processing.
boolean	isLoading Gets or sets whether the data source is currently loading data.
Event	loadingEvent Gets an event that will be raised when the data source either starts or stops loading.
String	name Gets or sets a human-readable name for this instance.
boolean	show Gets whether or not this data source should be displayed.

Constructor Summary

Constructors

Constructor and Description
CustomDataSource() A DataSource implementation which can be used to manually manage a group of entities.
CustomDataSource(String name) A DataSource implementation which can be used to manually manage a group of entities.

Method Summary

Modifier and Type	Method and Description
boolean	update(JulianDate time) Updates the data source to the provided time.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

changedEvent

@JsProperty
public Event changedEvent

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

clock

@JsProperty
public DataSourceClock clock

Gets or sets the clock for this instance.

clustering

@JsProperty
public EntityCluster clustering

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

entities

@JsProperty
public EntityCollection entities

Gets the collection of Entity instances.

errorEvent

@JsProperty
public Event errorEvent

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

isLoading

@JsProperty
public boolean isLoading

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

loadingEvent

@JsProperty
public Event loadingEvent

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

name

@JsProperty
public String name

Gets or sets a human-readable name for this instance.

show

@JsProperty
public boolean show

Gets whether or not this data source should be displayed.

Constructor Detail

CustomDataSource

@JsConstructor
public CustomDataSource()

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

     Example:
     
     DataSource dataSource = new CustomDataSource("myData");
     BillboardGraphicsOptions options = new BillboardGraphicsOptions();
     options.image = "image.png";
     EntityOptions entityOptions = new EntityOptions();
     entityOptions.billboard = new BillboardGraphics(options);
     Entity entity = dataSource.entities().add(new Entity(entityOptions));
     viewer.dataSources.add(dataSource);
     
 

CustomDataSource

@JsConstructor
public CustomDataSource(String name)

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

     Example:
     
     DataSource dataSource = new CustomDataSource("myData");
     BillboardGraphicsOptions options = new BillboardGraphicsOptions();
     options.image = "image.png";
     EntityOptions entityOptions = new EntityOptions();
     entityOptions.billboard = new BillboardGraphics(options);
     Entity entity = dataSource.entities().add(new Entity(entityOptions));
     viewer.dataSources.add(dataSource);
     
 

Parameters:

name - A human-readable name for this instance.

Method Detail

update

@JsMethod
 @JsIgnore
public boolean update(JulianDate time)

Description copied from interface: DataSource

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.

Specified by:

update in interface DataSource

Parameters:

time - The simulation time.

Returns:

True if this data source is ready to be displayed at the provided time, false otherwise.