org.cesiumjs.cs.collections

Class CompositeEntityCollection

java.lang.Object

org.cesiumjs.cs.collections.CompositeEntityCollection

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

Author:

Serge Silaev aka iSergio

Constructor Summary

Constructors

Constructor and Description
CompositeEntityCollection() Non-destructively composites multiple EntityCollection instances into a single collection.
CompositeEntityCollection(EntityCollection[] collections) Non-destructively composites multiple EntityCollection instances into a single collection.
CompositeEntityCollection(EntityCollection[] collections, CompositeEntityCollection owner) Non-destructively composites multiple EntityCollection instances into a single collection.
CompositeEntityCollection(EntityCollection[] collections, DataSource owner) Non-destructively composites multiple EntityCollection instances into a single collection.

Method Summary

Modifier and Type	Method and Description
void	addCollection(EntityCollection collection) Adds a collection to the composite.
void	addCollection(EntityCollection collection, int index) Adds a collection to the composite.
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.
boolean	containsCollection(EntityCollection collection) Checks to see if the composite contains a given collection.
Entity	getById(Object id) Gets an entity with the specified id.
EntityCollection	getCollection(int index) Gets a collection by index from the composite.
int	getCollectionsLength() Gets the number of collections in this composite.
String	id() Gets a globally unique identifier for this collection.
int	indexOfCollection(EntityCollection collection) Determines the index of a given collection in the composite.
void	lowerCollection(EntityCollection collection) Lowers a collection down one position in the composite.
void	lowerCollectionToBottom(EntityCollection collection) Lowers a collection to the bottom of the composite.
Object	owner() Gets the owner of this entity collection, ie. the data source or composite entity collection which created it.
void	raiseCollection(EntityCollection collection) Raises a collection up one position in the composite.
void	raiseCollectionToTop(EntityCollection collection) Raises a collection to the top of the composite.
void	removeAllCollections() Removes all collections from this composite.
boolean	removeCollection(EntityCollection collection) Removes a collection from this composite, if present.
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

Constructor Detail

CompositeEntityCollection

@JsConstructor
public CompositeEntityCollection()

Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.

CompositeEntityCollection

@JsConstructor
public CompositeEntityCollection(EntityCollection[] collections)

Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.

Parameters:

collections - The initial list of EntityCollection instances to merge.

CompositeEntityCollection

@JsConstructor
public CompositeEntityCollection(EntityCollection[] collections,
                                                DataSource owner)

Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.

Parameters:

collections - The initial list of EntityCollection instances to merge.

owner - The data source (or composite entity collection) which created this collection.

CompositeEntityCollection

@JsConstructor
public CompositeEntityCollection(EntityCollection[] collections,
                                                CompositeEntityCollection owner)

Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.

Parameters:

collections - The initial list of EntityCollection instances to merge.

owner - The data source (or composite entity collection) 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

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.

values

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

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

addCollection

@JsMethod
public void addCollection(EntityCollection collection)

Adds a collection to the composite.

Parameters:

collection - the collection to add.

addCollection

@JsMethod
public void addCollection(EntityCollection collection,
                                    int index)

Adds a collection to the composite.

Parameters:

collection - the collection to add.

index - the index to add the collection at. If omitted, the collection will added on top of all existing collections.

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 - The entity.

Returns:

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

containsCollection

@JsMethod
public boolean containsCollection(EntityCollection collection)

Checks to see if the composite contains a given collection.

Parameters:

collection - the collection to check for.

Returns:

true if the composite contains the collection, false otherwise.

getById

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.

getCollection

@JsMethod
public EntityCollection getCollection(int index)

Gets a collection by index from the composite.

Parameters:

index - the index to retrieve.

Returns:

collection by index

getCollectionsLength

@JsMethod
public int getCollectionsLength()

Gets the number of collections in this composite.

indexOfCollection

@JsMethod
public int indexOfCollection(EntityCollection collection)

Determines the index of a given collection in the composite.

Parameters:

collection - The collection to find the index of.

Returns:

The index of the collection in the composite, or -1 if the collection does not exist in the composite.

lowerCollection

@JsMethod
public void lowerCollection(EntityCollection collection)

Lowers a collection down one position in the composite.

Parameters:

collection - the collection to move.

lowerCollectionToBottom

@JsMethod
public void lowerCollectionToBottom(EntityCollection collection)

Lowers a collection to the bottom of the composite.

Parameters:

collection - the collection to move.

raiseCollection

@JsMethod
public void raiseCollection(EntityCollection collection)

Raises a collection up one position in the composite.

Parameters:

collection - the collection to move.

raiseCollectionToTop

@JsMethod
public void raiseCollectionToTop(EntityCollection collection)

Raises a collection to the top of the composite.

Parameters:

collection - the collection to move.

removeAllCollections

@JsMethod
public void removeAllCollections()

Removes all collections from this composite.

removeCollection

@JsMethod
public boolean removeCollection(EntityCollection collection)

Removes a collection from this composite, if present.

Parameters:

collection - The collection to remove.

Returns:

true if the collection was in the composite and was removed, false if the collection was not in the composite.

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 also ensures the collection is recomposited if events are also resumed. 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. While events are suspended, recompositing of the collections will also be suspended, as this can be a costly operation. This function can be safely called multiple times as long as there are corresponding calls to EntityCollection.resumeEvents().