TimelineAnimator

Kind of class: public class
Package:
Inherits from:
  • EventDispatcher
Classpath: org.asaplibrary.ui.animation.TimelineAnimator
File last modified: Friday, 13 May 2011, 22:20:34
Wrapper class to control a timeline animation and receive events when animations are done. The timeline animation can have labels "in" and "out" defined, that will be used as control points for specific animations. See each of the functions (goIn, goOut, playOneShotAnimation) for detailed behaviour description. Example: Suppose a MovieClip instance with instance name "tIntroAnimation" that is a child of the class in which the following code is defined. This MovieClip has labels "in" and "out" defined on its timeline. 
private var mAnimation : TimelineAnimation;
private function createUI() : void {
    mAnimation = new TimelineAnimator(tIntroAnimation);
    mAnimation.addEventListener(AnimationEvent._EVENT, handleAnimationEvent);
    mAnimation.goIn();
}
private function handleAnimationEvent (e:AnimationEvent) : void {
    switch (e.subtype) {
        case AnimationEvent.IN_ANIMATION_DONE: mAnimation.goOut(); break;
        case AnimationEvent.OUT_ANIMATION_DONE: mAnimation.goIn(); break;
    }
}

Summary

Constructor
Instance properties
Instance methods
  • playOneShotAnimation (inStart = * = 1) : void
    • Play single shot animation from the first frame, the provided location or the current position, until the last frame; animation stops at the first frame
  • goIn () : void
    • Start in animation at label "in" if defined, or current frame, until 1 frame before "out" frame if defined, or last frame; animation stops at the last frame
  • goOut () : void
    • Start out animation at label "out" if defined, or current frame, until last frame; animation stops at the first frame
  • toString () : String

Constructor

TimelineAnimator

function TimelineAnimator(inTarget:MovieClip)

Constructor

Parameters
inTarget:MovieClip to be controlled

Instance properties

target

target:MovieClip(read)
Returns
  • the target for this animator

Instance methods

goIn

function goIn() : void

Start in animation at label "in" if defined, or current frame, until 1 frame before "out" frame if defined, or last frame; animation stops at the last frame

goOut

function goOut() : void

Start out animation at label "out" if defined, or current frame, until last frame; animation stops at the first frame

playOneShotAnimation

function playOneShotAnimation(inStart = * = 1) : void

Play single shot animation from the first frame, the provided location or the current position, until the last frame; animation stops at the first frame

Parameters
inStart:frame number or label to start animation from; pass null to start from current position

toString

override function toString() : String
Overrides
  • EventDispatcher.toString