| Previous | Next | Frames | No Frames |
| Summary: Field | Property | Contructor | Method | Detail: Field | Property | Contructor | Method |
Object | +--xp.util.TweenTimer
Field Summary | |
| public | active: Boolean |
| Indicates whether the tween is active | |
| public | arrayMode: Boolean |
| Indicates the mode, if tween an array of propeties this field is true otherwise false | |
| public | context: Object |
| A context object that is passed toi the event handlers. The content can be anything you wish. | |
| public | duration: Number |
| The duratoin in ms of the tween | |
| public | ID: Number |
| A unique Id for this tween | |
| public | onTweenComplete |
| A callback handler for the onTweenComplete event | |
| public | onTweenDone |
| A callback handler for the onTweenDone event | |
| public | onTweenUpdate |
| A callback handler for the onTweenUpdate event | |
| public | property |
| The property or array of properties being tweened | |
| public | startTime: Number |
| The system time in ms when the tween started | |
| public | target: Object |
| public | valBegin |
| The property or array of property values at the start of the tween. | |
| public | valEnd |
| The property or array of property values at the end of the tween | |
Constructor | |
| public | TweenTimer ( tgt: Object, valBegin, valEnd, dur: Number, property, context: Object, onTweenUpdate, onTweenComplete, onTweenDone) |
| Creates a new TweenTimer instances | |
Method Summary | |
| public static | addTween ( tween: TweenTimer ): Void |
| Adds a TweenTimer to the managers list of active tweens | |
| public | easingEquation ( t, b, c, d ) |
| The easing equation | |
| public | getCurVal ( curTime ): Object |
| Gets the property value or values at he specified point in time | |
| public | onComplete ( ) |
| Called when the tween is complete | |
| public | onUpdate ( ) |
| Called to update the tweenable properties. | |
| public static | removeTween ( tween: TweenTimer ) |
| Removes a TweenTimer from the managers list of active tweens | |
| public | start ( ) |
| Starts or restarts a tween | |
| public static | startTween ( tgt: Object, valBegin, valEnd, dur: Number, property, context: Object, onTweenUpdate, onTweenComplete, onTweenDone ): TweenTimer |
| Creates, configures and starts a TweenTimer | |
| public static | startTweenFade ( tgt: MovieClip, inc: Boolean, context, onTweenDone ): TweenTimer |
| Creates a fade in/out tween | |
| public var active: Boolean |
| Indicates whether the tween is active |
| public var arrayMode: Boolean |
| Indicates the mode, if tween an array of propeties this field is true otherwise false |
| public var context: Object |
| A context object that is passed toi the event handlers. The content can be anything you wish. |
| public var duration: Number |
| The duratoin in ms of the tween |
| public var ID: Number |
| A unique Id for this tween |
| public var onTweenComplete |
| A callback handler for the onTweenComplete event This event fires on the last interval event of the tween and allows you to set the final tween value This can be a function on the target or a delegate. |
| public var onTweenDone |
| A callback handler for the onTweenDone event This event fires immediately after the onTweenComplete event and allows you to tidy up after the tween. This can be a function on the target or a delegate. Note: The function can call to a different object than onTweenComplete. A use for this is to have one object processing a specific tween and another that tidies up all tweens |
| public var onTweenUpdate |
| A callback handler for the onTweenUpdate event |
| public var property |
| The property or array of properties being tweened |
| public var startTime: Number |
| The system time in ms when the tween started |
| public var target: Object |
| public var valBegin |
| The property or array of property values at the start of the tween. |
| public var valEnd |
| The property or array of property values at the end of the tween |
|
| Creates a new TweenTimer instances | |||||||||||||||||||||||||||
|
|
| Adds a TweenTimer to the managers list of active tweens A TweenTimer will not fire any events until added to the tween manager | |||
|
|
| The easing equation This can be replaced by any equstion you like | ||||||||||||
|
|
| Gets the property value or values at he specified point in time | |||
|
|
| Called when the tween is complete |
|
| Called to update the tweenable properties. |
|
| Removes a TweenTimer from the managers list of active tweens A TweenTimer will not fire any events after it is removed from the tween manager | |||
|
|
| Starts or restarts a tween |
|
| Creates, configures and starts a TweenTimer | |||||||||||||||||||||||||||
|
|
| Creates a fade in/out tween | ||||||||||||
|
Usually you will call the static methods of thisclass to create the tween. This control is highly configurable and can support multi property tweens.
A tween can be created that is completely automated. It starts, updates properties itself, finishes and cleans up after itself. See startTweenFade for an example. A context object can be apssed on all evnt scall. The context object can contain any information you like can can help you in processing the tween event.
If onTweenUpdate/onTweenComplete/onTweenDone handlers are specified they are called.
If not specifeid and properties are then the proeprties will be automaticallly updated.
If neither are set then the target clip is called directly with the handlers.