Packagecom.gestureworks.cml.interfaces
Interfacepublic interface IState
Implementors TouchContainer

Implement state API Requires property state array: private var state:Array;



Public Properties
 PropertyDefined By
  stateId : *
Returns the current state id.
IState
Public Methods
 MethodDefined By
  
loadState(sId:* = null, recursion:Boolean = false):void
Loads state by index number.
IState
  
saveState(sId:* = null, recursion:Boolean = false):void
Save state by index number.
IState
  
tweenState(sId:* = null, tweenTime:Number = 1):void
Tween state by stateIndex from current to given state index.
IState
Property Detail
stateIdproperty
stateId:*

Returns the current state id.


Implementation
    public function get stateId():*
    public function set stateId(value:any):void
Method Detail
loadState()method
public function loadState(sId:* = null, recursion:Boolean = false):void

Loads state by index number. If the first parameter is NaN, the current state will be saved.

Parameters

sId:* (default = null) — State index to be loaded.
 
recursion:Boolean (default = false) — If true the state will load recursively through the display list starting at current display ojbect.

saveState()method 
public function saveState(sId:* = null, recursion:Boolean = false):void

Save state by index number. If the first parameter is NaN, the current state will be saved.

Parameters

sId:* (default = null) — State index to save.
 
recursion:Boolean (default = false) — If true the state will save recursively through the display list starting at current display ojbect.

tweenState()method 
public function tweenState(sId:* = null, tweenTime:Number = 1):void

Tween state by stateIndex from current to given state index. If the first parameter is null, the current state will be saved.

Parameters

sId:* (default = null) — State index to tween.
 
tweenTime:Number (default = 1) — Duration of tween