Class caurina.transitions.Tweener

Method Index

new Tweener()
addCaller(), addTween(), getControllerName(), getCurrentTweeningTime(), getTweenCount(), getTweens(), getVersion(), isTweening(), onEnterFrame(), pauseAllTweens(), pauseTweenByIndex(), pauseTweens(), printError(), registerSpecialProperty(), registerSpecialPropertyModifier(), registerSpecialPropertySplitter(), registerTransition(), removeAllTweens(), removeTweenByIndex(), removeTweens(), removeTweensByTime(), resumeAllTweens(), resumeTweenByIndex(), resumeTweens(), setTimeScale(), splitTweens(), updateFrame(), updateTime()

Constructor Detail

Tweener

public function Tweener()

There's no constructor.

Method Detail

addTween

static public function addTween(p_scopes:Object, p_parameters:Object):Boolean

Adds a new tweening

Parameters

Return

Boolean TRUE if the tween was successfully added, FALSE if otherwise

addCaller

static public function addCaller(p_scopes:Object, p_parameters:Object):Boolean

Adds a new *caller* tweening

Parameters

Return

Boolean TRUE if the tween was successfully added, FALSE if otherwise

removeTweensByTime

static public 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_scopeObject List of objects affected
p_propertiesObject List of properties affected (PropertyInfoObj instances)
p_timeStartNumber Time when the new tween starts
p_timeCompleteNumber Time when the new tween ends

Return

Boolean Whether or not it actually deleted something

removeTweens

static public function removeTweens(p_scope:Object):Boolean

Remove tweenings from a given object from the tweening list

Parameters

Return

Boolean Whether or not it successfully removed this tweening

removeAllTweens

static public function removeAllTweens():Boolean

Remove all tweenings from the engine

Return

Boolean Whether or not it successfully removed a tweening

pauseTweens

static public function pauseTweens(p_scope:Object):Boolean

Pause tweenings from a given object

Parameters

p_scopeObject Object that must have its tweens paused

Return

Boolean Whether or not it successfully paused something

pauseAllTweens

static public function pauseAllTweens():Boolean

Pause all tweenings on the engine

Return

Boolean Whether or not it successfully paused a tweening

resumeTweens

static public function resumeTweens(p_scope:Object):Boolean

Resume tweenings from a given object

Parameters

p_scopeObject Object that must have its tweens resumed

Return

Boolean Whether or not it successfully resumed something

resumeAllTweens

static public function resumeAllTweens():Boolean

Resume all tweenings on the engine

Return

Boolean Whether or not it successfully resumed a tweening

splitTweens

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

Splits a tweening in two

Parameters

p_tweenNumber Object that must have its tweens split
p_propertiesArray Array of strings containing the list of properties that must be separated

Return

Number The index number of the new tween

removeTweenByIndex

static public function removeTweenByIndex(p_tween:Number, p_finalRemoval:Boolean):Boolean

Remove an specific tweening from the tweening list

Parameters

p_tweenNumber Index of the tween to be removed on the tweenings list

Return

Boolean Whether or not it successfully removed this tweening

pauseTweenByIndex

static public function pauseTweenByIndex(p_tween:Number):Boolean

Pauses an specific tween

Parameters

p_tweenNumber Index of the tween to be paused

Return

Boolean Whether or not it successfully paused this tweening

resumeTweenByIndex

static public function resumeTweenByIndex(p_tween:Number):Boolean

Resumes an specific tween

Parameters

p_tweenNumber Index of the tween to be resumed

Return

Boolean Whether or not it successfully resumed this tweening

registerTransition

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

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

Parameters

p_nameString Shorthand transition name
p_functionFunction The proper equation function

registerSpecialProperty

static public function registerSpecialProperty(p_name:String, p_getFunction:Function, p_setFunction:Function, p_parameters:Array, p_preProcessFunction:Function):Void

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

Parameters

p_nameName of the "special" property.
p_getFunctionFunction that gets the value.
p_setFunctionFunction that sets the value.

registerSpecialPropertyModifier

static public 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_nameName of the "special" property modifier.
p_modifyFunctionFunction that modifies the value.
p_getFunctionFunction that gets the value.

registerSpecialPropertySplitter

static public function registerSpecialPropertySplitter(p_name:String, p_splitFunction:Function, p_parameters:Array):Void

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

Parameters

p_nameName of the "special" property splitter.
p_splitFunctionFunction that splits the value.

updateTime

static public function updateTime():Void

Updates the time to enforce time grid-based updates

updateFrame

static public function updateFrame():Void

Updates the current frame count

onEnterFrame

static public function onEnterFrame():Void

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

setTimeScale

static public function setTimeScale(p_time:Number):Void

Sets the new time scale.

Parameters

p_timeNumber New time scale (0.5 = slow, 1 = normal, 2 = 2x fast forward, etc)

isTweening

static public function isTweening(p_scope:Object):Boolean

Finds whether or not an object has any tweening

Parameters

p_scopeObject Target object

Return

Boolean Whether or not there's a tweening occuring on this object (paused, delayed, or active)

getTweens

static public function getTweens(p_scope:Object):Array

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

Parameters

p_scopeObject Target object

Return

Array List of strings with properties being tweened (including delayed or paused)

getTweenCount

static public function getTweenCount(p_scope:Object):Number

Return the number of properties being tweened for this object

Parameters

p_scopeObject Target object

Return

Number Total count of properties being tweened (including delayed or paused)

getCurrentTweeningTime

static public 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_tweeningTweenListObj Tween information

getVersion

static public function getVersion():String

Return the current tweener version

Return

String The number of the current Tweener version

getControllerName

static public function getControllerName():String

Return the name for the controller movieclip

Return

String The number of the current Tweener version

printError

static public function printError(p_message:String):Void

Output an error message

Parameters

p_messageString The error message to output