| Package | xp.utils |
| Class | public class Tween |
| Inheritance | Tween  flash.events.EventDispatcher |
| Subclasses | ChartEffect, PieSliceExplodeEffect, PieSliceRotateEffect |
See also
| Property | Defined by | ||
|---|---|---|---|
| active : Boolean [read-only]
Indicates whether the tween is active
| Tween | ||
| duration : int = 3000
The duration in ms of the tween
| Tween | ||
| easingEquation : Function
The easing equation
This can be replaced by any equation you like that takes the follwing params
| Tween | ||
| isFactory : Boolean = false
Is this a factory tween that generates clones of itself
| Tween | ||
| mode : String = "in"
The mode of tween
One of in or out.
| Tween | ||
| tweenId : int [read-only]
A unique Id for this tween
| Tween | ||
| tweenType : String [read-only]
The type of tween
| Tween | ||
| Property | Defined by | ||
|---|---|---|---|
| target : Object | Tween | ||
| tweenClass : Class | Tween | ||
| _tweenType : String = "tween" | Tween | ||
| Method | Defined by | ||
|---|---|---|---|
|
Tween(target:Object = null, mode:String = "in")
Creates a new Tween instances
| Tween | ||
|
getInstance(target:Object = null, mode:String = "in"):Tween
| Tween | ||
|
reverse():void
Plays a tween in reverse from the current point back to the beginning.
| Tween | ||
|
start():void
Starts or restarts a tween
| Tween | ||
|
stop(noevent:Boolean = true):void
Stops a tween
| Tween | ||
| Method | Defined by | ||
|---|---|---|---|
|
configureChildInstance(tween:Tween):void
| Tween | ||
|
end():void
| Tween | ||
|
getValue(endValue:Number, beginValue:Number):Number
Gets the property value at the current point in time
| Tween | ||
|
onTweenBegin():void
| Tween | ||
|
onTweenEnd():void
| Tween | ||
|
onTweenUpdate(value:Number):void
| Tween | ||
| active | property |
active:Boolean [read-only]Indicates whether the tween is active
Implementation public function get active():Boolean
| duration | property |
public var duration:int = 3000The duration in ms of the tween
| easingEquation | property |
public var easingEquation:FunctionThe easing equation This can be replaced by any equation you like that takes the follwing params
See also
| isFactory | property |
public var isFactory:Boolean = falseIs this a factory tween that generates clones of itself
| mode | property |
public var mode:String = "in"The mode of tween One of in or out. If in the tween value increases towards 1, if out it decreases to 0.
| target | property |
protected var target:Object
| tweenClass | property |
protected var tweenClass:Class
| tweenId | property |
tweenId:int [read-only]A unique Id for this tween
Implementation public function get tweenId():int
| _tweenType | property |
protected var _tweenType:String = "tween"
| tweenType | property |
tweenType:String [read-only]The type of tween
Implementation public function get tweenType():String
| Tween | () | constructor |
public function Tween(target:Object = null, mode:String = "in")Creates a new Tween instances
Parameterstarget:Object (default = null) |
|
mode:String (default = "in") |
| configureChildInstance | () | method |
| end | () | method |
protected function end():void
| getInstance | () | method |
public final function getInstance(target:Object = null, mode:String = "in"):TweenParameters
target:Object (default = null) |
|
mode:String (default = "in") |
Tween |
| getValue | () | method |
protected function getValue(endValue:Number, beginValue:Number):NumberGets the property value at the current point in time
ParametersendValue:Number — end value
|
|
beginValue:Number — beginning value
|
Number — The current value
|
| onTweenBegin | () | method |
protected function onTweenBegin():void
| onTweenEnd | () | method |
protected function onTweenEnd():void
| onTweenUpdate | () | method |
protected function onTweenUpdate(value:Number):voidParameters
value:Number |
| reverse | () | method |
public function reverse():voidPlays a tween in reverse from the current point back to the beginning. If a tween has been started and is running, reverse will play it backwards from the current time point to the starting point.
| start | () | method |
public function start():voidStarts or restarts a tween
| stop | () | method |
public function stop(noevent:Boolean = true):voidStops a tween
Parametersnoevent:Boolean (default = true) |