Packagecom.yogurt3d.core.managers.contextmanager
Classpublic class ContextManager
InheritanceContextManager Inheritance EngineObject Inheritance Object
Implements IContextManager


Public Properties
 PropertyDefined By
  cameras : Vector.<Camera>
[read-only] Returns the registered cameras
ContextManager
  contextCount : int
[read-only] Returns the registered context count
ContextManager
  contexts : Vector.<IContext>
[read-only] Returns the registered contexts
ContextManager
  renderers : Vector.<IRenderer>
[read-only] Returns the registered renderers
ContextManager
  scenes : Vector.<IScene>
[read-only] Returns the registered scenes
ContextManager
 InheritedsystemID : String
[read-only] Automatically assigned id.
EngineObject
 InheriteduserID : String
Identification string can be assigned by developer to identify objects.
EngineObject
  viewports : Vector.<Viewport>
[read-only] Returns the registered viewports
ContextManager
Public Methods
 MethodDefined By
  
ContextManager(_initInternals:Boolean = true)
ContextManager
  
addContext(_value:IContext):void
Registers a IContext object.
ContextManager
  
addNewContext(_scene:IScene, _camera:Camera, _viewport:Viewport, _renderer:IRenderer):String
Creates and registeres a new Context object.
ContextManager
 Inherited
clone():IEngineObject
Creates new clone object.
EngineObject
 Inherited
dispose():void
Removes all external referances and clears internals.
EngineObject
 Inherited
disposeDeep():void
EngineObject
 Inherited
disposeGPU():void
EngineObject
  
getContextBySystemID(_value:String):IContext
Fetches a registered Context object using it's system id
ContextManager
  
getContextByUserID(_value:String):IContext
Fetches a registered Context object using it's user id
ContextManager
 Inherited
instance():*
Removes all external referances and clears internals.
EngineObject
  
removeAllRelatedTo(_value:IEngineObject):void
Unregisters the Context object allocated to the IEngineObject
ContextManager
  
removeAllRelatedToCamera(_value:Camera):void
Unregisters the Context object allocated to the Camera
ContextManager
  
removeAllRelatedToRenderer(_value:IRenderer):void
Unregisters the Context object allocated to the IRenderer
ContextManager
  
removeAllRelatedToScene(_value:IScene):void
Unregisters the Context object allocated to the IScene
ContextManager
  
removeAllRelatedToViewport(_value:Viewport):void
Unregisters the Context object allocated to the Viewport
ContextManager
  
removeContext(_value:IContext):void
Unregisters a Context
ContextManager
  
removeContextBySystemID(_value:String):void
Unregisters a Context object by it's system id
ContextManager
  
removeContextByUserID(_value:String):void
Unregisters a Context object by it's user id
ContextManager
 Inherited
renew():void
Renews object internals and resets properties of object.
EngineObject
 Inherited
toString():String
Returns a string identifier on this object
EngineObject
Protected Methods
 MethodDefined By
  
initInternals():void
[override]
ContextManager
  
trackObject():void
[override] Starts the tracking of the object
ContextManager
Property Detail
camerasproperty
cameras:Vector.<Camera>  [read-only]

Returns the registered cameras


Implementation
    public function get cameras():Vector.<Camera>
contextCountproperty 
contextCount:int  [read-only]

Returns the registered context count


Implementation
    public function get contextCount():int
contextsproperty 
contexts:Vector.<IContext>  [read-only]

Returns the registered contexts


Implementation
    public function get contexts():Vector.<IContext>
m_camerasproperty 
YOGURT3D_INTERNAL var m_cameras:Vector.<Camera>

m_contextBySystemIDproperty 
YOGURT3D_INTERNAL var m_contextBySystemID:Dictionary

m_contextCountproperty 
YOGURT3D_INTERNAL var m_contextCount:int

m_contextsproperty 
YOGURT3D_INTERNAL var m_contexts:Vector.<IContext>

m_counterproperty 
YOGURT3D_INTERNAL var m_counter:Dictionary

m_renderersproperty 
YOGURT3D_INTERNAL var m_renderers:Vector.<IRenderer>

m_scenesproperty 
YOGURT3D_INTERNAL var m_scenes:Vector.<IScene>

m_viewportsproperty 
YOGURT3D_INTERNAL var m_viewports:Vector.<Viewport>

renderersproperty 
renderers:Vector.<IRenderer>  [read-only]

Returns the registered renderers


Implementation
    public function get renderers():Vector.<IRenderer>
scenesproperty 
scenes:Vector.<IScene>  [read-only]

Returns the registered scenes


Implementation
    public function get scenes():Vector.<IScene>
viewportsproperty 
viewports:Vector.<Viewport>  [read-only]

Returns the registered viewports


Implementation
    public function get viewports():Vector.<Viewport>
Constructor Detail
ContextManager()Constructor
public function ContextManager(_initInternals:Boolean = true)

Parameters
_initInternals:Boolean (default = true)
Method Detail
addContext()method
public function addContext(_value:IContext):void

Registers a IContext object.

Parameters

_value:IContext — The IContext object to be registered.

addNewContext()method 
public function addNewContext(_scene:IScene, _camera:Camera, _viewport:Viewport, _renderer:IRenderer):String

Creates and registeres a new Context object.

Parameters

_scene:IScene
 
_camera:Camera
 
_viewport:Viewport
 
_renderer:IRenderer

Returns
String —
getContextBySystemID()method 
public function getContextBySystemID(_value:String):IContext

Fetches a registered Context object using it's system id

Parameters

_value:String

Returns
IContext —
getContextByUserID()method 
public function getContextByUserID(_value:String):IContext

Fetches a registered Context object using it's user id

Parameters

_value:String — User id

Returns
IContext —
initInternals()method 
override protected function initInternals():void

removeAllRelatedTo()method 
public function removeAllRelatedTo(_value:IEngineObject):void

Unregisters the Context object allocated to the IEngineObject

Parameters

_value:IEngineObject

removeAllRelatedToCamera()method 
public function removeAllRelatedToCamera(_value:Camera):void

Unregisters the Context object allocated to the Camera

Parameters

_value:Camera

removeAllRelatedToRenderer()method 
public function removeAllRelatedToRenderer(_value:IRenderer):void

Unregisters the Context object allocated to the IRenderer

Parameters

_value:IRenderer

removeAllRelatedToScene()method 
public function removeAllRelatedToScene(_value:IScene):void

Unregisters the Context object allocated to the IScene

Parameters

_value:IScene

removeAllRelatedToViewport()method 
public function removeAllRelatedToViewport(_value:Viewport):void

Unregisters the Context object allocated to the Viewport

Parameters

_value:Viewport

removeContext()method 
public function removeContext(_value:IContext):void

Unregisters a Context

Parameters

_value:IContext — Context object that is going to be unregistered

removeContextBySystemID()method 
public function removeContextBySystemID(_value:String):void

Unregisters a Context object by it's system id

Parameters

_value:String

removeContextByUserID()method 
public function removeContextByUserID(_value:String):void

Unregisters a Context object by it's user id

Parameters

_value:String

trackObject()method 
override protected function trackObject():void

Starts the tracking of the object





Mon Jan 23 2012, 09:47 PM +05:00