Packagecom.boostworthy.animation.rendering
Classpublic class Renderer
InheritanceRenderer Inheritance flash.events.EventDispatcher
ImplementsIDisposable

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.

See also

com.boostworthy.animation.RenderMethod


Protected Properties
 PropertyDefined by
  m_fncOnEnterFrame : Function
Holds a reference to the enter frame event handler.
Renderer
  m_fncOnTimer : Function
Holds a reference to the timer event handler.
Renderer
  m_objLog : ILog
Holds a log for logging output about this object.
Renderer
  m_objStage : Stage
Holds a reference to the stage to be used for adding/removing listeners to the enter frame event.
Renderer
  m_objTimer : Timer
Holds a timer instance to be used by this renderer.
Renderer
Public Methods
 MethodDefined by
  
Renderer(fncOnEnterFrame:Function, fncOnTimer:Function, nRefreshRate:Number)
Constructor.
Renderer
  
dispose():void
Performs any appropriate clean-up tasks for garbage collection such as removing event listeners, setting object references to 'null', etc.
Renderer
  
start(nRenderMethod:Number):void
Starts rendering for the specified render method.
Renderer
  
startAll():void
Starts rendering for all render methods.
Renderer
  
stop(nRenderMethod:Number):void
Stops rendering for the specified render method.
Renderer
  
stopAll():void
Stops rendering for all render methods.
Renderer
Protected Methods
 MethodDefined by
  
Starts listening for the enter frame event.
Renderer
  
startTimer():void
Starts the timer.
Renderer
  
Stops listening for the enter frame event.
Renderer
  
stopTimer():void
Stops the timer.
Renderer
Property detail
m_fncOnEnterFrameproperty
protected var m_fncOnEnterFrame:Function

Holds a reference to the enter frame event handler.

m_fncOnTimerproperty 
protected var m_fncOnTimer:Function

Holds a reference to the timer event handler.

m_objLogproperty 
protected var m_objLog:ILog

Holds a log for logging output about this object.

m_objStageproperty 
protected var m_objStage:Stage

Holds a reference to the stage to be used for adding/removing listeners to the enter frame event.

m_objTimerproperty 
protected var m_objTimer:Timer

Holds a timer instance to be used by this renderer.

Constructor detail
Renderer()constructor
public function Renderer(fncOnEnterFrame:Function, fncOnTimer:Function, nRefreshRate:Number)

Constructor.

Parameters
fncOnEnterFrame:Function — A reference to the event handler for the enter frame event.
 
fncOnTimer:Function — A reference to the event handler for the timer event.
 
nRefreshRate:Number — This interval for the timer to be set at. The value is in milliseconds.
Method detail
dispose()method
public function dispose():void

Performs any appropriate clean-up tasks for garbage collection such as removing event listeners, setting object references to 'null', etc.

start()method 
public function start(nRenderMethod:Number):void

Starts rendering for the specified render method.

Parameters
nRenderMethod:Number — The method to start rendering for.

See also

startAll()method 
public function startAll():void

Starts rendering for all render methods.

startEnterFrame()method 
protected function startEnterFrame():void

Starts listening for the enter frame event.

startTimer()method 
protected function startTimer():void

Starts the timer.

stop()method 
public function stop(nRenderMethod:Number):void

Stops rendering for the specified render method.

Parameters
nRenderMethod:Number — The method to stop rendering for.

See also

stopAll()method 
public function stopAll():void

Stops rendering for all render methods.

stopEnterFrame()method 
protected function stopEnterFrame():void

Stops listening for the enter frame event.

stopTimer()method 
protected function stopTimer():void

Stops the timer.