Class Index | File Index

Classes


Class VENISON.GENERAL.FocusManager

Singleton that handles the foci: input focus and camera focus.
Defined in: venison_engine.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Get the id of the entity who currently has camera focus.
 
Get the id of the entity who currently has input focus.
 
Set the entity who should have camera focus.
 
fnSetFocusEntityID(iEntityID)
Convenience method to give an entity both camera focus and input focus.
 
Set the entity who should have input focus.
Class Detail
VENISON.GENERAL.FocusManager()
Method Detail
{Number} fnGetCameraFocusEntityID()
Get the id of the entity who currently has camera focus.
Returns:
{Number} The id of the entity who currently has camera focus, or null if no entity has camera focus.

{Number} fnGetInputFocusEntityID()
Get the id of the entity who currently has input focus.
Returns:
{Number} The id of the entity who currently has input focus, or null if no entity has input focus.

fnSetCameraFocusEntityID(iEntityID)
Set the entity who should have camera focus. The switch will be made after the current frame.
Parameters:
{Number} iEntityID
The id of the entity to receive camera focus after the current frame.
See:
VENISON.GENERAL.FocusManager#fnSetInputFocusEntityID
VENISON.GENERAL.FocusManager#fnSetFocusEntityID

fnSetFocusEntityID(iEntityID)
Convenience method to give an entity both camera focus and input focus.
Parameters:
{Number} iEntityID
The id of the entity to receive camera focus and input focus after the current frame.
See:
VENISON.GENERAL.FocusManager#fnSetInputFocusEntityID
VENISON.GENERAL.FocusManager#fnSetCameraFocusEntityID

fnSetInputFocusEntityID(iEntityID)
Set the entity who should have input focus. The switch will be made after the current frame.
Parameters:
{Number} iEntityID
The id of the entity to receive input focus after the current frame.
See:
VENISON.GENERAL.FocusManager#fnSetCameraFocusEntityID
VENISON.GENERAL.FocusManager#fnSetFocusEntityID

Documentation generated by JsDoc Toolkit 2.4.0 on Thu May 05 2011 18:47:28 GMT+0200 (CEST)