Packagegraphics.transitions
Classpublic class TweenUnit
InheritanceTweenUnit Inheritance Motion Inheritance CoreTransition Inheritance CoreAction Inheritance Task Inheritance Object
Subclasses TweenArray, TweenRange, TweenTo

The TweenUnit class interpolate in time a value between 0 and 1.

Example :

     package examples 
     {
         import graphics.transitions.TweenUnit;
         import graphics.easings.bounceOut;
         
         import system.process.Action;
         
         import flash.display.Sprite;
         
         public class ExampleTweenUnit extends Sprite
         {
             public function ExampleTweenUnit()
             {
                 tween = new TweenUnit ( bounceOut, 24, false, true ) ;
                 tween.changeIt.connect( change ) ;
                 tween.run() ;
             }
             
             public var tween:TweenUnit ;
             
             public function change( action:Action ):void
             {
                 trace( tween.position ) ;
             }
         }
     }
     



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
  easing : Function
Defines the easing method reference of this entry.
TweenUnit
 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
  position : Number
The current position of this tween.
TweenUnit
 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
 InheriteduseSeconds : Boolean
Defined if the Motion used seconds or not.
Motion
Public Methods
 MethodDefined By
  
TweenUnit(easing:* = null, duration:Number = 0, useSeconds:Boolean = false, auto:Boolean = false)
Creates a new TweenUnit instance.
TweenUnit
  
clone():*
[override] Returns a shallow copy of this Tween object.
TweenUnit
 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
  
set(easing:*, duration:Number = 0, useSeconds:Boolean = false):void
Set the TweenUnit properties.
TweenUnit
 Inherited
setTime(t:Number):void
Sets the current time within the duration of the animation.
Motion
 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.
TweenUnit
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
easingproperty
easing:Function

Defines the easing method reference of this entry.


Implementation
    public function get easing():Function
    public function set easing(value:Function):void
positionproperty 
public var position:Number

The current position of this tween.

Constructor Detail
TweenUnit()Constructor
public function TweenUnit(easing:* = null, duration:Number = 0, useSeconds:Boolean = false, auto:Boolean = false)

Creates a new TweenUnit instance.

Parameters
easing:* (default = null) — The easing equation reference.
 
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.
set()method 
public function set(easing:*, duration:Number = 0, useSeconds:Boolean = false):void

Set the TweenUnit properties.

Parameters

easing:* — the easing function of the tween entry.
 
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.

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

Update the current Tween in the time.