org.cesiumjs.cs.collections

Class EntityCollection

java.lang.Object

org.cesiumjs.cs.collections.EntityCollection

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

Author:

Serge Silaev aka iSergio

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	EntityCollection.CollectionChangedEventCallback The signature of the event generated by EntityCollection#collectionChanged.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	show Gets whether or not this entity collection should be displayed.

Constructor Summary

Constructors

Constructor and Description
EntityCollection() An observable collection of Entity instances where each entity has a unique id.
EntityCollection(CompositeEntityCollection object) An observable collection of Entity instances where each entity has a unique id.
EntityCollection(DataSource owner) An observable collection of Entity instances where each entity has a unique id.

Method Summary

Modifier and Type	Method and Description
Entity	add(Entity entity) Add an entity to the collection.
Entity	add(EntityOptions entityOptions) Add an entity to collection by entity options
Event	collectionChanged() Gets the event that is fired when entities are added or removed from the collection.
TimeInterval	computeAvailability() Computes the maximum availability of the entities in the collection.
boolean	contains(Entity entity) Returns true if the provided entity is in this collection, false otherwise.
Entity	getById(Object id) Gets an entity with the specified id.
Entity	getOrCreateEntity(Object id) Gets an entity with the specified id or creates it and adds it to the collection if it does not exist.
String	id() Gets a globally unique identifier for this collection.
Object	owner() Gets the owner of this entity collection, ie. the data source or composite entity collection which created it.
boolean	remove(Entity entity) Removes an entity from the collection.
void	removeAll() Removes all Entities from the collection.
boolean	removeById(Object id) Removes an entity with the provided id from the collection.
void	resumeEvents() Resumes raising EntityCollection#collectionChanged events immediately when an item is added or removed.
void	suspendEvents() Prevents EntityCollection#collectionChanged events from being raised until a corresponding call is made to EntityCollection#resumeEvents, at which point a single event will be raised that covers all suspended operations.
Entity[]	values() Gets the array of Entity instances in the collection.

Methods inherited from class java.lang.Object

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

Field Detail

show

@JsProperty
public boolean show

Gets whether or not this entity collection should be displayed. When true, each entity is only displayed if its own show property is also true.

Constructor Detail

EntityCollection

@JsConstructor
public EntityCollection()

An observable collection of Entity instances where each entity has a unique id.

EntityCollection

@JsConstructor
public EntityCollection(CompositeEntityCollection object)

An observable collection of Entity instances where each entity has a unique id.

Parameters:

object - CompositeEntityCollection Composite entity collection which created this collection.

EntityCollection

@JsConstructor
public EntityCollection(DataSource owner)

An observable collection of Entity instances where each entity has a unique id.

Parameters:

owner - DataSource The data source which created this collection.

Method Detail

collectionChanged

@JsProperty(name="collectionChanged")
public Event collectionChanged()

Gets the event that is fired when entities are added or removed from the collection. The generated event is a EntityCollection.collectionChangedEventCallback.

id

@JsProperty(name="id")
public String id()

Gets a globally unique identifier for this collection.

owner

@JsProperty(name="owner")
public Object owner()

Gets the owner of this entity collection, ie. the data source or composite entity collection which created it. DataSource | CompositeEntityCollection

values

@JsProperty(name="values")
public Entity[] values()

Gets the array of Entity instances in the collection. This array should not be modified directly.

add

@JsMethod
public Entity add(Entity entity)

Add an entity to the collection.

Parameters:

entity - The entity to be added.

Returns:

The entity that was added.

add

@JsMethod
public Entity add(EntityOptions entityOptions)

Add an entity to collection by entity options

Parameters:

entityOptions - Entity options

Returns:

The entity that was added.

computeAvailability

@JsMethod
public TimeInterval computeAvailability()

Computes the maximum availability of the entities in the collection. If the collection contains a mix of infinitely available data and non-infinite data, it will return the interval pertaining to the non-infinite data only. If all data is infinite, an infinite interval will be returned.

Returns:

The availability of entities in the collection.

contains

@JsMethod
public boolean contains(Entity entity)

Returns true if the provided entity is in this collection, false otherwise.

Parameters:

entity - true if the provided entity is in this collection, false otherwise.

Returns:

true if the provided entity is in this collection, false otherwise.

getById

@JsMethod
public Entity getById(Object id)

Gets an entity with the specified id.

Parameters:

id - The id of the entity to retrieve.

Returns:

The entity with the provided id or undefined if the id did not exist in the collection.

getOrCreateEntity

@JsMethod
public Entity getOrCreateEntity(Object id)

Gets an entity with the specified id or creates it and adds it to the collection if it does not exist.

Parameters:

id - The id of the entity to retrieve or create.

Returns:

The new or existing object.

remove

public boolean remove(Entity entity)

Removes an entity from the collection.

Parameters:

entity - The entity to be removed.

Returns:

true if the item was removed, false if it did not exist in the collection.

removeAll

@JsMethod
public void removeAll()

Removes all Entities from the collection.

removeById

@JsMethod
public boolean removeById(Object id)

Removes an entity with the provided id from the collection.

Parameters:

id - The id of the entity to remove.

Returns:

true if the item was removed, false if no item with the provided id existed in the collection.

resumeEvents

@JsMethod
public void resumeEvents()

Resumes raising EntityCollection#collectionChanged events immediately when an item is added or removed. Any modifications made while while events were suspended will be triggered as a single event when this function is called. This function is reference counted and can safely be called multiple times as long as there are corresponding calls to EntityCollection#resumeEvents.

suspendEvents

@JsMethod
public void suspendEvents()

Prevents EntityCollection#collectionChanged events from being raised until a corresponding call is made to EntityCollection#resumeEvents, at which point a single event will be raised that covers all suspended operations. This allows for many items to be added and removed efficiently. This function can be safely called multiple times as long as there are corresponding calls to EntityCollection#resumeEvents.