org.cesiumjs.cs.datasources

Class CzmlDataSource

java.lang.Object

org.cesiumjs.cs.datasources.CzmlDataSource

All Implemented Interfaces:

DataSource

@JsType(isNative=true,
        namespace="Cesium",
        name="CzmlDataSource")
public class CzmlDataSource
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 the clock settings defined by the loaded CZML.
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 a value indicating if 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 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
CzmlDataSource() A DataSource which processes CZML.
CzmlDataSource(String name) A DataSource which processes CZML.

Method Summary

Modifier and Type	Method and Description
static Promise<CzmlDataSource,Void>	load(Object data) Creates a Promise to a new instance loaded with the provided CZML data.
static Promise<CzmlDataSource,Void>	load(Object data, CzmlDataSourceOptions options) Creates a Promise to a new instance loaded with the provided CZML data.
static Promise<CzmlDataSource,Void>	load(String data) Creates a Promise to a new instance loaded with the provided CZML data.
static Promise<CzmlDataSource,Void>	load(String data, CzmlDataSourceOptions options) Creates a Promise to a new instance loaded with the provided CZML data.
Promise<CzmlDataSource,Void>	process(Object czml) Processes the provided url or CZML object without clearing any existing data.
Promise<CzmlDataSource,Void>	process(Object czml, CzmlDataSourceOptions options) Processes the provided url or CZML object without clearing any existing data.
Promise<CzmlDataSource,Void>	process(String czml) Processes the provided url or CZML object without clearing any existing data.
Promise<CzmlDataSource,Void>	process(String czml, CzmlDataSourceOptions options) Processes the provided url or CZML object without clearing any existing data.
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 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

@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 a value indicating if 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 a human-readable name for this instance.

show

@JsProperty
public Boolean show

Gets whether or not this data source should be displayed.

Constructor Detail

CzmlDataSource

@JsConstructor
public CzmlDataSource()

A DataSource which processes CZML.

CzmlDataSource

@JsConstructor
public CzmlDataSource(String name)

A DataSource which processes CZML.

Parameters:

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

Method Detail

load

@JsMethod
public static Promise<CzmlDataSource,Void> load(String data)

Creates a Promise to a new instance loaded with the provided CZML data.

Parameters:

data - A url to be processed.

Returns:

A promise that resolves to the new instance once the data is processed.

load

@JsMethod
public static Promise<CzmlDataSource,Void> load(String data,
                                                          CzmlDataSourceOptions options)

Creates a Promise to a new instance loaded with the provided CZML data.

Parameters:

data - A url to be processed.

options - Options.

Returns:

A promise that resolves to the new instance once the data is processed.

load

@JsMethod
public static Promise<CzmlDataSource,Void> load(Object data)

Creates a Promise to a new instance loaded with the provided CZML data.

Parameters:

data - CZML object to be processed.

Returns:

A promise that resolves to the new instance once the data is processed.

load

@JsMethod
public static Promise<CzmlDataSource,Void> load(Object data,
                                                          CzmlDataSourceOptions options)

Creates a Promise to a new instance loaded with the provided CZML data.

Parameters:

data - CZML object to be processed.

options - Options.

Returns:

A promise that resolves to the new instance once the data is processed.

process

@JsMethod
public Promise<CzmlDataSource,Void> process(String czml)

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

Parameters:

czml - A url to be processed.

Returns:

A promise that resolves to this instances once the data is processed.

process

@JsMethod
public Promise<CzmlDataSource,Void> process(String czml,
                                                      CzmlDataSourceOptions options)

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

Parameters:

czml - A url to be processed.

options - CzmlDataSourceOptions

Returns:

A promise that resolves to this instances once the data is processed.

process

@JsMethod
public Promise<CzmlDataSource,Void> process(Object czml)

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

Parameters:

czml - CZML object to be processed.

Returns:

A promise that resolves to this instances once the data is processed.

process

@JsMethod
public Promise<CzmlDataSource,Void> process(Object czml,
                                                      CzmlDataSourceOptions options)

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

Parameters:

czml - CZML object to be processed.

options - CzmlDataSourceOptions

Returns:

A promise that resolves to this instances once the data is processed.

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.