Packagecom.addicted2flash.tween
Classpublic class Flux
ImplementsIFlux

Tween object with the capability to start, stop, pause, resume tweens.


Public Properties
 PropertyDefined by
  attachment : *
[read-only] Returns the specified attachment.
Flux
  fluxObserverCount : int
[read-only] Returns the total amount of observers.
Flux
  property : Property
[write-only] Sets first property of the flux.
Flux
  state : int
[read-only] Returns the state of the IFlux.
Flux
  totalDuration : int
[read-only] Returns the duration of the tween.
Flux
Public Methods
 MethodDefined by
  
addFluxObserver(o:IFluxObserver):void
Adds a IFluxObserver.
Flux
  
create(duration:int, delay:int, attachment:Property = null, property:* = null):IFlux
[static] Creates a new Flux.
Flux
  
createAndStart(duration:int, delay:int, runOnce:Boolean, attachment:Property, property:*):IFlux
[static] Creates a new Flux and automatically starts it.
Flux
  
dispose():void
free memory for garbage collection.
Flux
  
pause():void
Pause the tween.
Flux
  
removeFluxObserver(o:IFluxObserver):void
Removes a IFluxObserver.
Flux
  
resume():void
Resumes the tween.
Flux
  
reverse():void
Starts the tween in reverse direction.
Flux
  
start():void
Starts the tween.
Flux
  
stop():void
Stopps the tween.
Flux
Property detail
attachmentproperty
attachment:*  [read-only]

Returns the specified attachment.

Implementation
    public function get attachment():*
fluxObserverCountproperty 
fluxObserverCount:int  [read-only]

Returns the total amount of observers.

Implementation
    public function get fluxObserverCount():int
propertyproperty 
property:Property  [write-only]

Sets first property of the flux.

NOTE: use Property.create()

Implementation
    public function set property(value:Property):void
stateproperty 
state:int  [read-only]

Returns the state of the IFlux.

Implementation
    public function get state():int
totalDurationproperty 
totalDuration:int  [read-only]

Returns the duration of the tween.

Implementation
    public function get totalDuration():int
Method detail
addFluxObserver()method
public function addFluxObserver(o:IFluxObserver):void

Adds a IFluxObserver.

Parameters
o:IFluxObserver — observer to be added
create()method 
public static function create(duration:int, delay:int, attachment:Property = null, property:* = null):IFlux

Creates a new Flux.

Parameters
duration:int — duration of the tween
 
delay:int — if object should be disposed after tweening (faster!)
 
attachment:Property (default = null) — property to render (can be nested as linked list)
 
property:* (default = null)

Returns
IFlux — flux
createAndStart()method 
public static function createAndStart(duration:int, delay:int, runOnce:Boolean, attachment:Property, property:*):IFlux

Creates a new Flux and automatically starts it.

Parameters
duration:int — duration of the tween
 
delay:int — if object should be disposed after tweening (faster!)
 
runOnce:Boolean — property to render (can be nested as linked list)
 
attachment:Property
 
property:*

Returns
IFlux — flux
dispose()method 
public function dispose():void

free memory for garbage collection.

pause()method 
public function pause():void

Pause the tween.

removeFluxObserver()method 
public function removeFluxObserver(o:IFluxObserver):void

Removes a IFluxObserver.

Parameters
o:IFluxObserver — observer to be removed
resume()method 
public function resume():void

Resumes the tween.

reverse()method 
public function reverse():void

Starts the tween in reverse direction.

start()method 
public function start():void

Starts the tween.

stop()method 
public function stop():void

Stopps the tween.




Copyright 2009 - Tim Richter