org.cesiumjs.cs.collections

Class ModelAnimationCollection

java.lang.Object

org.cesiumjs.cs.collections.Collection<ModelAnimation>

org.cesiumjs.cs.collections.ModelAnimationCollection

@JsType(isNative=true,
        namespace="Cesium",
        name="ModelAnimationCollection")
public class ModelAnimationCollection
extends Collection<ModelAnimation>

A collection of active model animations. Access this using Model.activeAnimations.

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
Event	animationAdded The event fired when an animation is added to the collection.
Event	animationRemoved The event fired when an animation is removed from the collection.

Constructor Summary

Constructors

Constructor and Description
ModelAnimationCollection()

Method Summary

Modifier and Type	Method and Description
ModelAnimation	add(ModelAnimationOptions options) Creates and adds an animation with the specified initial properties to the collection.
ModelAnimation[]	addAll(ModelAnimationOptions options) Creates and adds an animation with the specified initial properties to the collection for each animation in the model.

Methods inherited from class org.cesiumjs.cs.collections.Collection

add, add, contains, destroy, get, isDestroyed, length, remove, remove, removeAll, update

Methods inherited from class java.lang.Object

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

Field Detail

animationAdded

@JsProperty
public Event animationAdded

The event fired when an animation is added to the collection. This can be used, for example, to keep a UI in sync. Default: new Event()

animationRemoved

@JsProperty
public Event animationRemoved

The event fired when an animation is removed from the collection. This can be used, for example, to keep a UI in sync. Default: new Event()

Constructor Detail

ModelAnimationCollection

@JsConstructor
public ModelAnimationCollection()

Method Detail

add

@JsMethod
public ModelAnimation add(ModelAnimationOptions options)

Creates and adds an animation with the specified initial properties to the collection. This raises the ModelAnimationCollection#animationAdded event so, for example, a UI can stay in sync.

Parameters:

options - ModelAnimationOptions

Returns:

The animation that was added to the collection.

addAll

@JsMethod
public ModelAnimation[] addAll(ModelAnimationOptions options)

Creates and adds an animation with the specified initial properties to the collection for each animation in the model. This raises the ModelAnimationCollection#animationAdded event for each model so, for example, a UI can stay in sync.

Parameters:

options - ModelAnimationOptions

Returns:

An array of ModelAnimation objects, one for each animation added to the collection. If there are no glTF animations, the array is empty.