Skip to content
This repository has been archived by the owner on Oct 14, 2024. It is now read-only.

SequenceAnimation

MikhailTymchukDX edited this page Apr 12, 2017 · 2 revisions

SequenceAnimation (inherits ParentAnimation)

The SequenceAnimation runs several animations one after the other. It can also repeat the sequence of animations for a specified number of iterations (which defaults to a single iteration, but will repeat forever if you specify zero or less iterations). Also, the SequenceAnimation cannot be a child of a Sys.Extended.UI.Animation.ParallelAnimation (or any animation inheriting from it).

Client properties

Name Description
isInfinite A boolean value that determines whether or not animation runs in an infinite loop until it is explicitly stopped.
iterations Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence will repeat forever. The default value is 1 iteration.

Client methods

Name Description
constructor(target, duration, fps, animations, iterations) The SequenceAnimation ignores the duration and fps properties, and will let each of its child animations use any settings they please.
onEnd() The onEnd method is called just after the animation is played each time.
onStart() The onStart method is called just before the animation is played each time.
onStep(percentage) Raises an invalid operation exception because this will only be called if a SequenceAnimation has been nested inside an Sys.Extended.UI.Animation.ParallelAnimation (or a derived type).
pause() Pause the animation if it is playing. Calling play will resume where the animation left off.
play() Play the sequence of animations from the beginning or where it was left off when paused.
stop() Stop playing the entire sequence of animations.

Client properties

isInfinite

A boolean value that determines whether or not animation runs in an infinite loop until it is explicitly stopped.

Getter name: get_isInfinite()

iterations

Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence will repeat forever. The default value is 1 iteration.

Getter name: get_iterations()
Setter name: set_iterations(value)

Client methods

constructor(target, duration, fps, animations, iterations)

The SequenceAnimation ignores the duration and fps properties, and will let each of its child animations use any settings they please.

Params:

  • target

    • Type: Object
    • Description: Target of the animation.
  • duration

    • Type: Number
    • Description: Length of the animation in seconds. The default is 1.
  • fps

    • Type: Number
    • Description: Number of steps per second. The default is 25.
  • animations

    • Type: Object
    • Description: Array of child animations.
  • iterations

    • Type: Number
    • Description: Number of times to repeatedly play the sequence. If zero or less iterations are specified, the sequence will repeat forever. The default value is 1 iteration.

onEnd()

The onEnd method is called just after the animation is played each time.

onStart()

The onStart method is called just before the animation is played each time.

onStep(percentage)

Raises an invalid operation exception because this will only be called if a SequenceAnimation has been nested inside an Sys.Extended.UI.Animation.ParallelAnimation (or a derived type).

Params:

  • percentage
    • Type: Number
    • Description: Percentage of the animation already complete.

pause()

Pause the animation if it is playing. Calling play will resume where the animation left off.

Remarks: If this animation is the child of another, you must call pause on its parent instead.

play()

Play the sequence of animations from the beginning or where it was left off when paused.

Remarks: If this animation is the child of another, you must call play on its parent instead.

stop()

Stop playing the entire sequence of animations.

Remarks: Stopping this animation will perform the last step of each child animation, thereby leaving their target elements in a state consistent with the animation playing completely. If this animation is the child of another, you must call stop on its parent instead.

Clone this wiki locally