Class Index | File Index

Classes


Class R.collision.broadphase.AbstractCollisionNode

A node within a broad-phase collision model which contains a list of game objects within it.
Defined in: abstractcollisionnode.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Abstract class from which broad-phase collision model nodes are derived
Method Summary
Method Attributes Method Name and Description
 
addObject(obj)
Add an object to this node.
 
Clear the dirty flag after the node has been processed.
 
contains(point)
Returns true if the spatial node contains the point specified.
 
Get the class name of this object
 
Get the count of objects within the node.
 
Get the unique index of this node.
 
Get a Container which is all objects within this node.
 
Returns true if the node is dirty (has been modified)
 
Remove an object from this node
Class Detail
R.collision.broadphase.AbstractCollisionNode()
Abstract class from which broad-phase collision model nodes are derived
Method Detail
addObject(obj)
Add an object to this node.
Parameters:
obj
{R.engine.BaseObject} The object to add to this node.

clearDirty()
Clear the dirty flag after the node has been processed.

{Boolean} contains(point)
Returns true if the spatial node contains the point specified.
Parameters:
point
{R.math.Point2D} The point to check
Returns:
{Boolean}

{String} getClassName()
Get the class name of this object
Returns:
{String} "R.collision.broadphase.AbstractCollisionNode"

{Number} getCount()
Get the count of objects within the node.
Returns:
{Number}

{Number} getIndex()
Get the unique index of this node.
Returns:
{Number} The index of this node

{R.struct.Container} getObjects()
Get a Container which is all objects within this node.
Returns:
{R.struct.Container} Objects in the node

{Boolean} isDirty()
Returns true if the node is dirty (has been modified)
Returns:
{Boolean}

removeObject(obj)
Remove an object from this node
Parameters:
obj
{R.object.BaseObject} The object to remove from this node

Documentation generated by JsDoc Toolkit 2.4.0 on Mon Mar 18 2013 16:09:15 GMT-0400 (EDT)