Packagecaurina.transitions
Classpublic class Tweener
InheritanceTweener Inheritance Object


Public Properties
 PropertyDefined By
  autoOverwrite : Boolean = true
[static]
Tweener
Public Methods
 MethodDefined By
  
addCaller(p_scopes:Object = null, p_parameters:Object = null):Boolean
[static] Adds a new caller tweening.
Tweener
  
addTween(p_scopes:Object = null, p_parameters:Object = null):Boolean
[static] Adds a new tweening.
Tweener
  
getCurrentTweeningTime(p_tweening:Object):Number
[static] Get the current tweening time (no matter if it uses frames or time as basis), given a specific tweening
Tweener
  
getTweenCount(p_scope:Object):Number
[static] Returns the number of properties being tweened for a given object.
Tweener
  
getTweens(p_scope:Object):Array
[static] Returns an array containing a list of the properties being tweened for this object.
Tweener
  
getVersion():String
[static] Return the current tweener version
Tweener
  
init(... rest):void
[static] Initiates the Tweener--should only be ran once.
Tweener
  
isTweening(p_scope:Object):Boolean
[static] Finds whether or not an object has any tweening.
Tweener
  
onEnterFrame(e:Event):void
[static] Ran once every frame.
Tweener
  
pauseAllTweens():Boolean
[static] Pause all tweenings on the engine.
Tweener
  
pauseTweenByIndex(p_tween:Number):Boolean
[static] Pauses a specific tween.
Tweener
  
pauseTweens(p_scope:Object, ... args):Boolean
[static] Pause tweenings for a given object.
Tweener
  
printError(p_message:String):void
[static] Output an error message
Tweener
  
registerSpecialProperty(p_name:String, p_getFunction:Function, p_setFunction:Function, p_parameters:Array = null, p_preProcessFunction:Function = null):void
[static] Adds a new special property to the available special property list.
Tweener
  
registerSpecialPropertyModifier(p_name:String, p_modifyFunction:Function, p_getFunction:Function):void
[static] Adds a new special property modifier to the available modifier list.
Tweener
  
registerSpecialPropertySplitter(p_name:String, p_splitFunction:Function, p_parameters:Array = null):void
[static] Adds a new special property splitter to the available splitter list.
Tweener
  
registerTransition(p_name:String, p_function:Function):void
[static] Adds a new function to the available transition list "shortcuts".
Tweener
  
removeAllTweens():Boolean
[static] Remove all tweenings from the engine.
Tweener
  
removeTweenByIndex(i:Number, p_finalRemoval:Boolean = false):Boolean
[static] Remove a specific tweening from the tweening list.
Tweener
  
removeTweens(p_scope:Object, ... args):Boolean
[static] Remove tweenings from a given object from the tweening list.
Tweener
  
removeTweensByTime(p_scope:Object, p_properties:Object, p_timeStart:Number, p_timeComplete:Number):Boolean
[static] Remove an specified tweening of a specified object the tweening list, if it conflicts with the given time.
Tweener
  
resumeAllTweens():Boolean
[static] Resume all tweenings on the engine.
Tweener
  
resumeTweenByIndex(p_tween:Number):Boolean
[static] Resumes a specific tween.
Tweener
  
resumeTweens(p_scope:Object, ... args):Boolean
[static] Resume tweenings from a given object.
Tweener
  
setTimeScale(p_time:Number):void
[static] Sets the new time scale.
Tweener
  
splitTweens(p_tween:Number, p_properties:Array):uint
[static] Splits a tweening in two
Tweener
  
updateFrame():void
[static] Updates the current frame count
Tweener
  
updateTime():void
[static] Updates the time to enforce time grid-based updates.
Tweener
Property Detail
autoOverwriteproperty
public static var autoOverwrite:Boolean = true

Method Detail
addCaller()method
public static function addCaller(p_scopes:Object = null, p_parameters:Object = null):Boolean

Adds a new caller tweening.

Parameters

p_scopes:Object (default = null) — param) Object that should be tweened: a movieclip, textfield, etc.. OR an array of objects
 
p_parameters:Object (default = null) — param) Object containing the specified parameters in any order, as well as the properties that should be tweened and their values

Returns
Boolean — true if the tween was successfully added, false if otherwise.
addTween()method 
public static function addTween(p_scopes:Object = null, p_parameters:Object = null):Boolean

Adds a new tweening.

Parameters

p_scopes:Object (default = null) — param) Object Object that should be tweened: a movieclip, textfield, etc.. OR an array of objects
 
p_parameters:Object (default = null) — param) Object Object containing the specified parameters in any order, as well as the properties that should be tweened and their values

Returns
Boolean — Boolean TRUE if the tween was successfully added, FALSE if otherwise
getCurrentTweeningTime()method 
public static function getCurrentTweeningTime(p_tweening:Object):Number

Get the current tweening time (no matter if it uses frames or time as basis), given a specific tweening

Parameters

p_tweening:Object — TweenListObj Tween information

Returns
Number
getTweenCount()method 
public static function getTweenCount(p_scope:Object):Number

Returns the number of properties being tweened for a given object.

Parameters

p_scope:Object — Target object.

Returns
Number — Total number of properties being tweened (including delayed or paused tweens).
getTweens()method 
public static function getTweens(p_scope:Object):Array

Returns an array containing a list of the properties being tweened for this object.

Parameters

p_scope:Object — Target object.

Returns
Array — Total number of properties being tweened (including delayed or paused tweens).
getVersion()method 
public static function getVersion():String

Return the current tweener version

Returns
String — String The number of the current Tweener version
init()method 
public static function init(... rest):void

Initiates the Tweener--should only be ran once.

Parameters

... rest

isTweening()method 
public static function isTweening(p_scope:Object):Boolean

Finds whether or not an object has any tweening.

Parameters

p_scope:Object — Target object.

Returns
Boolean — true if there's a tweening occuring on this object (paused, delayed, or active), false if otherwise.
onEnterFrame()method 
public static function onEnterFrame(e:Event):void

Ran once every frame. It's the main engine; updates all existing tweenings.

Parameters

e:Event

pauseAllTweens()method 
public static function pauseAllTweens():Boolean

Pause all tweenings on the engine.

Returns
Boolean — true if it successfully paused any tweening, false if otherwise.

See also

resumeAllTweens()
pauseTweenByIndex()method 
public static function pauseTweenByIndex(p_tween:Number):Boolean

Pauses a specific tween.

Parameters

p_tween:Number — Number Index of the tween to be paused

Returns
Boolean — Boolean Whether or not it successfully paused this tweening
pauseTweens()method 
public static function pauseTweens(p_scope:Object, ... args):Boolean

Pause tweenings for a given object.

Parameters

p_scope:Object — Object that must have its tweens paused
 
... args — params) Property(ies) that must be paused

Returns
Boolean — true if it successfully paused any tweening, false if otherwise.
printError()method 
public static function printError(p_message:String):void

Output an error message

Parameters

p_message:String — String The error message to output

registerSpecialProperty()method 
public static function registerSpecialProperty(p_name:String, p_getFunction:Function, p_setFunction:Function, p_parameters:Array = null, p_preProcessFunction:Function = null):void

Adds a new special property to the available special property list.

Parameters

p_name:String — Name of the "special" property.
 
p_getFunction:Function — Function that gets the value.
 
p_setFunction:Function — Function that sets the value.
 
p_parameters:Array (default = null)
 
p_preProcessFunction:Function (default = null)

registerSpecialPropertyModifier()method 
public static function registerSpecialPropertyModifier(p_name:String, p_modifyFunction:Function, p_getFunction:Function):void

Adds a new special property modifier to the available modifier list.

Parameters

p_name:String — Name of the "special" property modifier.
 
p_modifyFunction:Function — Function that modifies the value.
 
p_getFunction:Function — Function that gets the value.

registerSpecialPropertySplitter()method 
public static function registerSpecialPropertySplitter(p_name:String, p_splitFunction:Function, p_parameters:Array = null):void

Adds a new special property splitter to the available splitter list.

Parameters

p_name:String — Name of the "special" property splitter.
 
p_splitFunction:Function — Function that splits the value.
 
p_parameters:Array (default = null)

registerTransition()method 
public static function registerTransition(p_name:String, p_function:Function):void

Adds a new function to the available transition list "shortcuts".

Parameters

p_name:String — String Shorthand transition name
 
p_function:Function — Function The proper equation function

removeAllTweens()method 
public static function removeAllTweens():Boolean

Remove all tweenings from the engine.

Returns
Boolean — true if it successfully removed any tweening, false if otherwise.
removeTweenByIndex()method 
public static function removeTweenByIndex(i:Number, p_finalRemoval:Boolean = false):Boolean

Remove a specific tweening from the tweening list.

Parameters

i:Number — Number Index of the tween to be removed on the tweenings list
 
p_finalRemoval:Boolean (default = false)

Returns
Boolean — Boolean Whether or not it successfully removed this tweening
removeTweens()method 
public static function removeTweens(p_scope:Object, ... args):Boolean

Remove tweenings from a given object from the tweening list.

Parameters

p_scope:Object — Object Object that must have its tweens removed
 
... args — params) Object Property(ies) that must be removed

Returns
Boolean — Boolean Whether or not it successfully removed this tweening
removeTweensByTime()method 
public static function removeTweensByTime(p_scope:Object, p_properties:Object, p_timeStart:Number, p_timeComplete:Number):Boolean

Remove an specified tweening of a specified object the tweening list, if it conflicts with the given time.

Parameters

p_scope:Object — Object List of objects affected
 
p_properties:Object — Object List of properties affected (PropertyInfoObj instances)
 
p_timeStart:Number — Number Time when the new tween starts
 
p_timeComplete:Number — Number Time when the new tween ends

Returns
Boolean — Boolean Whether or not it actually deleted something
resumeAllTweens()method 
public static function resumeAllTweens():Boolean

Resume all tweenings on the engine.

Returns
Boolean — true if it successfully resumed any tweening, false if otherwise.

See also

pauseAllTweens()
resumeTweenByIndex()method 
public static function resumeTweenByIndex(p_tween:Number):Boolean

Resumes a specific tween.

Parameters

p_tween:Number — Number Index of the tween to be resumed

Returns
Boolean — Boolean Whether or not it successfully resumed this tweening
resumeTweens()method 
public static function resumeTweens(p_scope:Object, ... args):Boolean

Resume tweenings from a given object.

Parameters

p_scope:Object — Object Object that must have its tweens resumed
 
... args — params) Object Property(ies) that must be resumed

Returns
Boolean — Boolean Whether or not it successfully resumed something
setTimeScale()method 
public static function setTimeScale(p_time:Number):void

Sets the new time scale.

Parameters

p_time:Number — Number New time scale (0.5 = slow, 1 = normal, 2 = 2x fast forward, etc)

splitTweens()method 
public static function splitTweens(p_tween:Number, p_properties:Array):uint

Splits a tweening in two

Parameters

p_tween:Number — Number Object that must have its tweens split
 
p_properties:Array — Array Array of strings containing the list of properties that must be separated

Returns
uint — Number The index number of the new tween
updateFrame()method 
public static function updateFrame():void

Updates the current frame count

updateTime()method 
public static function updateTime():void

Updates the time to enforce time grid-based updates.





Sun Apr 17 2011, 12:17 AM -07:00