Skip to main content
Version: 3.9.0

Animation Sequence Controller

animation sequence controller

Use Animation Sequence Controller to control animation sequence playback and its relevant properties. The animation sequence frame index starts from zero. When From is equal to To, only one frame will be played. When the first frame index is greater than the last frame index, the animation sequence is played backwards. Animation Sequence Controller is in the Utility category.

Input

NameData TypeDescription
PlayExecPlay the animation sequence from the index set in From.
StopExecStop the animation sequence playback and turn off the visibility of the current animation component.
PauseExecPause the animation sequence playback without turning off the visibility.
ResumeExecResume the animation sequence playback from the paused index.
ComponentAnimation SequenceThe animation sequence component.
FromNumberThe frame index of the animation sequence that will be played first.
ToNumberThe frame index of the animation sequence that will be played last. The maximum available index is the total frame count minus 1.
LoopNumberThe number of times the animation sequence is played.
Stop on LastBoolSelect it to stop the animation sequence playback after playing the last frame.

Output

NameData TypeDescription
ExitExecExecute the next node.
On PlayExecExecute the next node when it plays the first frame for the first time.
On Each PlayExecExecute the next node when it plays the first frame.
On Each StopExecExecute the next node when it plays the last frame.
On StopExecExecute the next node when the animation sequence playback stops.
Current FrameNumberThe current playback frame index.

Example

This example uses the Animation Sequence Controller component to control the play, pause, resume and stop of an animation sequence in Effect House. First, it imports a texture sequence that is composed of ten images of random questions.

questions

Then it adds the Animation Sequence Controller to the scene by adding an image entity and then attaching an animation sequence component to that entity. It then replaces the texture sequence with the one imported. Uncheck the AutoPlay checkbox on the Animation Sequence Controller component.

animation sequence controller example

Play with some parameters to customize the sequence play. This example lets the sequence play from the third frame (index 2) to the 9th frame (index 8). Animation sequences are 0-indexed in this node.

animation sequence controller node

Use the Animation Sequence Controller node to control the sequence. Use the index finger up gesture to trigger the play of animation sequence:

demo 1

Use the Facial Movement Detection node and the Eye Blink event to pause the play of animation sequence. Use the Victory gesture to trigger the resume of the sequence play. In this case, the sequence will be paused but will not disappear.

demo 2

Last but not least, use the mouth open event to trigger the stop of the sequence. In this case, the entire animation sequence will disappear.

demo 3