Packageorg.coretween
Classpublic class TweenManager
InheritanceTweenManager Inheritance Object

The TweenManager class is responsible for the management of all Tween objects that implement the Tweenable interface, this includes both Tween and Effect objects. The TweenManager is implemented as a singleton and no instances of the TweenManager should be created.


Public Properties
 PropertyDefined By
  fps : uint
[static] Sets or returns the current time based FPS.
TweenManager
  paused : Boolean
[static] [read-only] Returns the paused state.
TweenManager
  renderType : uint
[static] Use this property to change the default render type.
TweenManager
Public Methods
 MethodDefined By
  
TweenManager()
This is the TweenManager class constructor.
TweenManager
  
pause(... args):void
[static] Use this method to pause or resume all tweens that are currently under the control of the tween manager.
TweenManager
  
register(tween:Tweenable):void
[static] Use this method to register an object with the tween manager that implements the Tweenable interface.
TweenManager
  
release():void
[static] Releases the tween manager.
TweenManager
  
resume():void
[static] Use this method to resume all tweens that where previously paused with the TweenManager pause method.
TweenManager
  
rewind():void
[static] Use this method to rewind all tweens that are currently under control of the tween manager.
TweenManager
  
unregister(tween:Tweenable):void
[static] Use this method to unregister an object with the tween manager that implements the Tweenable interface.
TweenManager
Property Detail
fpsproperty
fps:uint

Sets or returns the current time based FPS. Use this property to set CoreTween's internal time based rendering fps. The higher this value the more smooth your animations will be. Keep in mind however that the fps set through this property is no guaranteed interval. So for instance, when setting this value to 60 then the Flash Player will try to keep this fps but it is in no way guaranteed. When setting this value its range can be set from 0 to 60. the default value for this property is 60. Setting this property to zero will disable CoreTweens time based renderer.


Implementation
    public static function get fps():uint
    public function set fps(value:uint):void
pausedproperty 
paused:Boolean  [read-only]

Returns the paused state. When pausing the TweenManager all tweens that are currently under the tween managers control will be paused.


Implementation
    public static function get paused():Boolean

See also

TweenManager.pause()
renderTypeproperty 
renderType:uint

Use this property to change the default render type. By default the type of rendering is set to Tween.FRAME and all Tween objects instantiated will have their rendering type set to Tween.FRAME. Setting this property allows you to change the default render type to Tween.TIME.


Implementation
    public static function get renderType():uint
    public function set renderType(value:uint):void

See also

Tween.type
Constructor Detail
TweenManager()Constructor
public function TweenManager()

This is the TweenManager class constructor. No instances of the TweenManager have to be created in order to use the TweenManager.

Method Detail
pause()method
public static function pause(... args):void

Use this method to pause or resume all tweens that are currently under the control of the tween manager. Calling this method when all tweens are paused will resume all tweens, reversing the paused state. However, calling this method when only some tweens are paused will not cause the paused tweens to resume, they will stay paused. Resuming the paused state of the tween manager will cause all tweens to be un-paused.

Parameters

... args

See also

TweenManager.paused
TweenManager.resume()
register()method 
public static function register(tween:Tweenable):void

Use this method to register an object with the tween manager that implements the Tweenable interface. When an object is registered with it can be controlled and updated by the tween manager. Normally when an opject is registered it is automatically unregistered when the object's stop method is called or when the tween of the object is completed.

Parameters

tween:Tweenable

See also

TweenManager.unregister()
release()method 
public static function release():void

Releases the tween manager. Use this method to shutdown the tween manager. If after releasing the tween manager its necessary to start the teen manager again, simply tell a Tween instance to start and the tween manager will be re-initialised.

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

Use this method to resume all tweens that where previously paused with the TweenManager pause method. Calling this method will resume all tweens, also tweens that where previously not set to a paused state by the tween manager.

See also

TweenManager.paused
TweenManager.pause()
rewind()method 
public static function rewind():void

Use this method to rewind all tweens that are currently under control of the tween manager.

unregister()method 
public static function unregister(tween:Tweenable):void

Use this method to unregister an object with the tween manager that implements the Tweenable interface. Normally it is not necessary to call this method manually. In normal circumstances it is called when a tweenable object is stopped or completed.

Parameters

tween:Tweenable

See also

TweenManager.register




Mon Aug 10 2009, 08:23 PM +10:00