Class Index | File Index

Classes


Class VENISON.GRAPHICS.GraphicsManager

Singleton used for updating the graphics.
Defined in: venison_engine.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Get the camera with a specific name.
 
Get all the entities registered within the GraphicsManager.
 
fnGetEntitiesInRect(iHalfWidth, iHalfHeight, iTransformation, iOnlyFullyInside)
Get all the entities within a rectangle.
 
fnGetEntityOnPosition(iWorldPos, iIncludeInvisibles)
Get the entity on a certain position.
 
fnRegisterCameraWithName(iCamera, iName)
Register a camera with a specific name.
Class Detail
VENISON.GRAPHICS.GraphicsManager()
Method Detail
{VENISON.GRAPHICS.Camera} fnGetCameraByName(iName)
Get the camera with a specific name.
Parameters:
{String} iName
The name of the camera.
Returns:
{VENISON.GRAPHICS.Camera} The camera with name iName.

{Array} fnGetEntities()
Get all the entities registered within the GraphicsManager.
Returns:
{Array} An array of arrays representing all the layers and the entities on them.

{Array} fnGetEntitiesInRect(iHalfWidth, iHalfHeight, iTransformation, iOnlyFullyInside)
Get all the entities within a rectangle.
Parameters:
{Number} iHalfWidth
Half the width of the rect.
{Number} iHalfHeight
Half the height of the rect.
{VENISON.UTILITIES.Transformation} iTransformation
The transformation of the rect.
{Boolean} iOnlyFullyInside
If true, only entities that are fully contained within the rect are returned.
Returns:
{Array} An array of the entities contained fully (if iOnlyFullyInside = true) or partially (iOnlyFullyInside = false).

{VENISON.ENTITY.GameEntity} fnGetEntityOnPosition(iWorldPos, iIncludeInvisibles)
Get the entity on a certain position.
Parameters:
{VENISON.UTILITIES.Vector2} iWorldPos
The position in world space.
{Boolean} iIncludeInvisibles
true if invisible entities should be considered.
Returns:
{VENISON.ENTITY.GameEntity} The topmost (highest graphicsLayer) entity whose graphics covers the world point defined by iWorldPos. null if no entity was found.

fnRegisterCameraWithName(iCamera, iName)
Register a camera with a specific name. NOTE: If a camera with name iName is already registered, that camera will be overwritten. You have been warned.
Parameters:
{VENISON.GRAPHICS.Camera} iCamera
The camera to register.
{String} iName
The name of the camera.

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