org.cesiumjs.cs.scene

Class ModelAnimation

java.lang.Object

org.cesiumjs.cs.scene.ModelAnimation

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

An active glTF animation. A glTF asset can contain animations. An active animation is an animation that is currently playing or scheduled to be played because it was added to a model's ModelAnimationCollection. An active animation is an instance of an animation; for example, there can be multiple active animations for the same glTF animation, each with a different start time. Create this by calling ModelAnimationCollection.add(ModelAnimationOptions).

Author:

Serge Silaev aka iSergio

Field Summary

Fields

Modifier and Type	Field and Description
boolean	removeOnStop When true, the animation is removed after it stops playing.
Event	start The event fired when this animation is started.
Event	stop The event fired when this animation is stopped.
Event	update The event fired when on each frame when this animation is updated.

Method Summary

Modifier and Type	Method and Description
double	delay() The delay, in seconds, from ModelAnimation#startTime to start playing.
Number	loop() Determines if and how the animation is looped.
double	multiplier() Values greater than 1.0 increase the speed that the animation is played relative to the scene clock speed; values less than 1.0 decrease the speed.
String	name() The glTF animation name that identifies this animation.
boolean	reverse() When true, the animation is played in reverse.
JulianDate	startTime() The scene time to start playing this animation.
JulianDate	stopTime() The scene time to stop playing this animation.

Methods inherited from class java.lang.Object

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

Field Detail

removeOnStop

@JsProperty
public boolean removeOnStop

When true, the animation is removed after it stops playing. This is slightly more efficient that not removing it, but if, for example, time is reversed, the animation is not played again. Default: false

start

@JsProperty
public Event start

The event fired when this animation is started. This can be used, for example, to play a sound or start a particle system, when the animation starts. This event is fired at the end of the frame after the scene is rendered. Default: new Event()

stop

@JsProperty
public Event stop

The event fired when this animation is stopped. This can be used, for example, to play a sound or start a particle system, when the animation stops. This event is fired at the end of the frame after the scene is rendered. Default: new Event()

update

@JsProperty
public Event update

The event fired when on each frame when this animation is updated. The current time of the animation, relative to the glTF animation time span, is passed to the event, which allows, for example, starting new animations at a specific time relative to a playing animation. This event is fired at the end of the frame after the scene is rendered. Default: new Event()

Method Detail

delay

@JsProperty(name="delay")
public double delay()

The delay, in seconds, from ModelAnimation#startTime to start playing. Default: undefined

loop

@JsProperty(name="loop")
public Number loop()

Determines if and how the animation is looped. Default: ModelAnimationLoop.NONE()

name

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

The glTF animation name that identifies this animation.

reverse

@JsProperty(name="reverse")
public boolean reverse()

When true, the animation is played in reverse. Default: false

multiplier

@JsProperty(name="multiplier")
public double multiplier()

Values greater than 1.0 increase the speed that the animation is played relative to the scene clock speed; values less than 1.0 decrease the speed. A value of 1.0 plays the animation at the speed in the glTF animation mapped to the scene clock speed. For example, if the scene is played at 2x real-time, a two-second glTF animation will play in one second even if multiplier is 1.0.

startTime

@JsProperty(name="startTime")
public JulianDate startTime()

The scene time to start playing this animation. When this is undefined, the animation starts at the next frame. Default: undefined

stopTime

@JsProperty(name="stopTime")
public JulianDate stopTime()

The scene time to stop playing this animation. When this is undefined, the animation is played for its full duration and perhaps repeated depending on ModelAnimation#loop. Default: undefined