Packagegraphics.transitions
Classpublic class TweenLite
InheritanceTweenLite Inheritance Motion Inheritance CoreTransition Inheritance CoreAction Inheritance Task Inheritance Object

The TweenLite class lets you use ActionScript to move, resize, and fade movie clips easily on the Stage by specifying a property of the target movie clip to be tween animated over a number of frames or seconds. The TweenLite class also lets you specify a variety of easing methods.

Easing refers to gradual acceleration or deceleration during an animation, which helps your animations appear more realistic.

Example :

     import graphics.transitions.TweenLite ;
     import graphics.easings.backOut ;
     var tween:TweenLite = new TweenLite (mc, "x", backOut, mc.x, 400, 2, true, true) ;
     



Public Properties
 PropertyDefined By
 InheritedchangeIt : Signaler
This signal emit when the notifyChanged method is invoked.
CoreAction
 InheritedclearIt : Signaler
This signal emit when the notifyCleared method is invoked.
CoreAction
 Inheritedduration : Number
Returns the duration of the tweened animation in frames or seconds.
Motion
 InheritedfinishIt : Signaler
This signal emit when the notifyFinished method is invoked.
Task
 Inheritedfps : Number
Returns the number of frames per second of the tweened animation.
Motion
 Inheritedid : *
Indicates the id value of this object.
CoreTransition
 InheritedinfoIt : Signaler
This signal emit when the notifyInfo method is invoked.
CoreAction
 Inheritedlogger : Logger
Determinates the internal Logger reference of this Loggable object.
Task
 Inheritedlooping : Boolean
The flag to determinate if the Action object is looped.
CoreAction
 InheritedloopIt : Signaler
This signal emit when the notifyLooped method is invoked.
CoreAction
 InheritedpauseIt : Signaler
This signal emit when the notifyPause method is invoked.
CoreAction
 Inheritedphase : String
[read-only] The current phase of the action.
Task
 InheritedprevTime : Number
Defined the internal prevTime value.
Motion
 InheritedprogressIt : Signaler
This signal emit when the notifyProgress method is invoked.
CoreAction
 InheritedresumeIt : Signaler
This signal emit when the notifyResumed method is invoked.
CoreAction
 Inheritedrunning : Boolean
[read-only] Indicates true if the process is in progress.
Task
 InheritedstartIt : Signaler
This signal emit when the notifyStarted method is invoked.
Task
 InheritedstopIt : Signaler
This signal emit when the notifyStopped method is invoked.
CoreAction
 Inheritedstopped : Boolean
[read-only] Indicates if the motion is stopped.
Motion
 Inheritedtarget : *
Indicates the target reference of the object contrains by the Motion effect.
Motion
 Inheritedtime : Number
[read-only] Indicates the current time within the duration of the animation.
Motion
 InheritedtimeoutIt : Signaler
This signal emit when the notifyTimeOut method is invoked.
CoreAction
  tweenEntry : TweenEntry
The TweenEntry reference of this tween.
TweenLite
 InheriteduseSeconds : Boolean
Defined if the Motion used seconds or not.
Motion
Public Methods
 MethodDefined By
  
TweenLite(obj:* = null, prop:String = null, easing:* = null, begin:Number, finish:Number, duration:Number = 0, useSeconds:Boolean = false, auto:Boolean = false)
Creates a new TweenLite instance.
TweenLite
  
clone():*
[override] Returns a shallow copy of this Tween object.
TweenLite
  
continueTo(finish:Number, duration:Number, noRestart:Boolean = false):void
Instructs the tweened animation to continue tweening from its current animation point to a new finish and duration point.
TweenLite
 Inherited
equals(o:*):Boolean
Compares the specified object with this object for equality.
CoreTransition
 Inherited
isLocked():Boolean
Returns true if the object is locked.
Task
 Inherited
lock():void
Locks the object.
Task
 Inherited
nextFrame():void
Forwards the tweened animation to the next frame.
Motion
 Inherited
Notify when the process is changed.
CoreAction
 Inherited
Notify when the process is cleared.
CoreAction
 Inherited
Notify an ActionEvent when the process is finished.
Task
 Inherited
notifyInfo(info:*):void
Notify a specific information when the process is changed.
CoreAction
 Inherited
Notify when the process is looped.
CoreAction
 Inherited
Notify when the process is paused.
CoreAction
 Inherited
Notify when the process is in progress.
CoreAction
 Inherited
Notify when the process is resumed.
CoreAction
 Inherited
Notify an ActionEvent when the process is started.
Task
 Inherited
Notify when the process is stopped.
CoreAction
 Inherited
Notify when the process is out of time.
CoreAction
 Inherited
prevFrame():void
Directs the tweened animation to the frame previous to the current frame.
Motion
 Inherited
resume():void
[override] Resumes a tweened animation from its stopped point in the animation.
Motion
 Inherited
rewind(t:Number = 0):void
Rewinds a tweened animation to the beginning of the tweened animation.
Motion
 Inherited
run(... arguments):void
[override] Runs the object.
Motion
 Inherited
setTime(t:Number):void
Sets the current time within the duration of the animation.
Motion
  
setTweenEntry(prop:String, easing:*, begin:Number, finish:Number):void
Set the TweenEntry property of this TweenLite object.
TweenLite
 Inherited
start():void
[override] Starts the tweened animation from the beginning.
Motion
 Inherited
Starts the intenral interval of the tweened animation.
Motion
 Inherited
stop():void
[override] Stops the tweened animation at its current position.
Motion
 Inherited
Stops the intenral interval of the tweened animation.
Motion
 Inherited
unlock():void
Unlocks the display.
Task
  
update():void
[override] Update the current Tween in the time.
TweenLite
  
yoyo():void
Instructs the tweened animation to play in reverse from its last direction of tweened property increments.
TweenLite
Protected Methods
 MethodDefined By
 Inherited
setRunning(b:Boolean):void
Changes the running property value.
Task
 Inherited
setTimer(timer:ITimer):void
Sets the internal timer of the tweened animation.
Motion
Property Detail
tweenEntryproperty
tweenEntry:TweenEntry

The TweenEntry reference of this tween.

Example :

         import graphics.transitions.TweenEntry ;
         import graphics.transitions.TweenLite ;
         import graphics.easings.bounceOut ;
         
         var tw:TweenLite = new TweenLite( mc ) ;
         tw.duration   = 1 ;
         tw.useSeconds = true ;
         
         tw.tweenEntry = new TweenEntry( "x" , bounceOut, mc.x , 500 ) ;
         tw.start() ;
         


Implementation
    public function get tweenEntry():TweenEntry
    public function set tweenEntry(value:TweenEntry):void
Constructor Detail
TweenLite()Constructor
public function TweenLite(obj:* = null, prop:String = null, easing:* = null, begin:Number, finish:Number, duration:Number = 0, useSeconds:Boolean = false, auto:Boolean = false)

Creates a new TweenLite instance.

Parameters
obj:* (default = null) — The target object of this tween.
 
prop:String (default = null) — The property name of the object to interpolate.
 
easing:* (default = null) — The easing equation reference (use a Function or an Easing object)..
 
begin:Number (default = NaN) — A number indicating the begining value of the target object property that is to be tweened.
 
finish:Number (default = NaN) — A number indicating the ending value of the target object property that is to be tweened.
 
duration:Number (default = 0) — A number indicating the length of time or number of frames for the tween motion.
 
useSeconds:Boolean (default = false) — Indicates if the duration is in seconds.
 
auto:Boolean (default = false) — Run the tween automatically.
Method Detail
clone()method
override public function clone():*

Returns a shallow copy of this Tween object.

Returns
* — a shallow copy of this Tween object.
continueTo()method 
public function continueTo(finish:Number, duration:Number, noRestart:Boolean = false):void

Instructs the tweened animation to continue tweening from its current animation point to a new finish and duration point.

Example :

         system system.events.ActionEvent ;
         
         import graphics.transitions.TweenLite ;
         import graphics.easings.bounceOut ;
         import system.process.Action ;
         
         var continueTo:Function = function( action:Action ):void
         {
             trace("continueTo(100,2)" ) ;
             tw.continueTo( 100 , 3 ) ;
         }
         
         var tw:TweenLite = new TweenLite( mc, "x", bounceOut, mc.x, 550, 1, true ) ;
         
         tw.finishIt.connect( continueTo , 0 , true ) ; 
         
         tw.run() ;
         

Parameters

finish:Number — A number indicating the ending value of the target object property that is to be tweened.
 
duration:Number (default = NaN) — A number indicating the length of time or number of frames for the tween motion.
 
noRestart:Boolean (default = false) — This optional flag is used to fix the restart process of the tween.

setTweenEntry()method 
public function setTweenEntry(prop:String, easing:*, begin:Number, finish:Number):void

Set the TweenEntry property of this TweenLite object.

Parameters

prop:String — the property name of the object to change.
 
easing:* — the easing function of the tween entry (use a Function or an Easing object).
 
begin:Number — the begin value.
 
finish:Number — the finish value.

update()method 
override public function update():void

Update the current Tween in the time.

yoyo()method 
public function yoyo():void

Instructs the tweened animation to play in reverse from its last direction of tweened property increments. If this method is called before a Tween object's animation is complete, the animation abruptly jumps to the end of its play and then plays in a reverse direction from that point.

Example :

         import system.events.ActionEvent ;
         
         import graphics.transitions.TweenLite ;
         import graphics.easings.bounceOut ;
         import system.process.Action ;
         
         var yoyo:Function = function( action:Action ):void
         {
             trace( "yoyo" ) ;
             tw.yoyo() ;
         }
         
         var tw:TweenLite = new TweenLite( mc, "x", bounceOut, mc.x, 550, 2, true ) ;
         tw.finishIt.connect( finish ) ; 
         tw.run() ;