Properties
animation
loop
The number of times the animation will repeat. Set to LoopIndefinitely to repeat indefinitely. Default is 0
nodeIdOffset
A base offset value which will be applied to all node identifiers in the animation attached to this player. This is useful to play an authored animation for a model that has been loaded into the scene after initial startup. In this situation the authored node identifiers in the animation may not match up with the runtime node identifiers in the current scene. The Model.getNodeIdOffset function can be used on the loaded model's root node to retrieve the correct offset value.
onComplete
Callback function to be called when the animation is complete. Will not be triggered if the player is looping.
speed
Scale value to be applied to animation time.
Static LoopIndefinitely
If loop is set to LoopIndefinitely, the animation will play repeatedly.
Methods
evaluate
-
Calculate the values for each channel of the associated Animation at the given time.
Parameters
-
time: number
The time at which to evaluate the animation.
-
Optional out: BatchedValues
Storage for the evaluated values. If supplied, this object will be returned instead of a new BatchedValues object. This allows values gathered from multiple players to be combined into one batch.
Returns BatchedValues
-
getAnimationTime
-
Gets the current time in seconds of the entire animation.
Returns number
getCurrentTime
-
Gets the current time in seconds that the animation has been playing.
Returns number
getState
-
Gets the current animation state.
Returns PlayerState
pause
-
Pauses animation playback.
Returns void
play
-
Starts playing the animation.
Returns void
reload
-
Updates internal state of animation player.
Call this method after any part of the underlying animation has been updated.
Returns void
setChannelEnabled
-
Sets the enabled state for a channel in this players animation. All channels are enabled by default when a player is created. A channel that has been disabled will not have its value interpolated by the system until it is re-enabled
Parameters
-
channel: NodeChannel | CameraChannel
a channel from the underlying animation
-
enabled: boolean
boolean value indicating whether the channel should be enabled.
Returns void
-
setTime
-
Sets the current animation time.
Parameters
-
time: number
time in milliseconds
Returns void
-
stop
-
Stops animation playback and resets the current time to 0.
Returns void
The animation played by this player