EventDispatcher |
Renderer |
The ‘Renderer’ class is essentially a wrapper API around the different render methods. You can use it to routinely call methods using the enter frame event or a timer event.
com.boostworthy.animation.RenderMethod
| Renderer | The ‘Renderer’ class is essentially a wrapper API around the different render methods. |
| Variables | |
| m_fncOnEnterFrame | Holds a reference to the enter frame event handler. |
| m_objTimer | Holds a timer instance to be used by this renderer. |
| m_fncOnTimer | Holds a reference to the timer event handler. |
| m_objStage | Holds a reference to the stage to be used for adding/removing listeners to the enter frame event. |
| Functions | |
| Renderer | Constructor. |
| start | Starts rendering for the specified render method. |
| stop | Stops rendering for the specified render method. |
| startAll | Starts rendering for all render methods. |
| stopAll | Stops rendering for all render methods. |
| dispose | Performs any appropriate clean-up tasks for garbage collection such as removing event listeners, setting object references to ‘null’, etc. |
| startEnterFrame | Starts listening for the enter frame event. |
| stopEnterFrame | Stops listening for the enter frame event. |
| startTimer | Starts the timer. |
| stopTimer | Stops the timer. |
| setRefreshRate | Sets the refresh rate of this renderer if it is Timer driven. |
public function Renderer( fncOnEnterFrame: Function, fncOnTimer: Function, nRefreshRate: Number )
Constructor.
| param | fncOnEnterFrame A reference to the event handler for the enter frame event. |
| param | fncOnTimer A reference to the event handler for the timer event. |
| param | nRefreshRate This interval for the timer to be set at. The value is in milliseconds. |
Holds a reference to the enter frame event handler.
protected var m_fncOnEnterFrame: Function
Holds a timer instance to be used by this renderer.
protected var m_objTimer: Timer
Holds a reference to the timer event handler.
protected var m_fncOnTimer: Function
Holds a reference to the stage to be used for adding/removing listeners to the enter frame event.
protected var m_objStage: Stage
Constructor.
public function Renderer( fncOnEnterFrame: Function, fncOnTimer: Function, nRefreshRate: Number )
Starts rendering for the specified render method.
public function start( nRenderMethod: Number ):void
Stops rendering for the specified render method.
public function stop( nRenderMethod: Number ):void
Starts rendering for all render methods.
public function startAll():void
Stops rendering for all render methods.
public function stopAll():void
Performs any appropriate clean-up tasks for garbage collection such as removing event listeners, setting object references to ‘null’, etc.
public function dispose():void
Starts listening for the enter frame event.
protected function startEnterFrame():void
Stops listening for the enter frame event.
protected function stopEnterFrame():void
Starts the timer.
protected function startTimer():void
Stops the timer.
protected function stopTimer():void
Sets the refresh rate of this renderer if it is Timer driven.
public function setRefreshRate( nRefreshRate: Number ):void