Fork me on GitHub

API Documentation


Extends GLGE.Animatable, GLGE.JSONLoader, GLGE.Placeable, GLGE.QuickNotation.
Group class to allow object transform hierarchies
Defined in: glge_group.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GLGE.Group(uid)
Method Summary
Method Attributes Method Name and Description
 
addChild(object)
Adds a new object to this group
 
 
 
Gets the bounding volume for this group
 
Gets an array of all children in this group
 
getLights(pointer)
Gets a list of all lights in this group
 
getNames(names)
Gets the name of the object and names of any sub objects
 
getObjects(pointer)
Gets a list of all objects in this group
 
Gets the pickable flag for the object
 
Gets the groups visibility
 
Checks if resources have finished downloading
 
removeChild(object)
Removes an object or sub group from this group
 
setAction(action, blendTime, loop)
Sets the action for this Group
 
setPickable(value)
Sets the pickable flag for the object
 
setVisible(visable)
Sets the groups visibility
 
Forces an update of all shaders and programs in this group
Methods borrowed from class GLGE.Animatable:
animate, blendTo, getAnimation, getBlendFunction, getFrameNumber, getFrameRate, getLoop, getName, getPaused, isLooping, setAnimation, setBlendFunction, setFrameRate, setLoop, setName, setPaused, setStartFrame, togglePaused
Methods borrowed from class GLGE.Events:
addEventListener, fireEvent, removeEventListener
Methods borrowed from class GLGE.Placeable:
clearStaticMatrix, getDLocX, getDLocY, getDLocZ, getDRotX, getDRotY, getDRotZ, getDScaleX, getDScaleY, getDScaleZ, getId, getInverseModelMatrix, getLocalMatrix, getLocX, getLocY, getLocZ, getLookat, getModelMatrix, getPosition, getQuatW, getQuatX, getQuatY, getQuatZ, getRef, getRoot, getRotation, getRotMatrix, getRotOrder, getRotX, getRotY, getRotZ, getScale, getScaleMatrix, getScaleX, getScaleY, getScaleZ, getTranslateMatrix, getTransposeInverseModelMatrix, getTransposeModelMatrix, getUpAxis, Lookat, move, setDLoc, setDLocX, setDLocY, setDLocZ, setDRot, setDRotX, setDRotY, setDRotZ, setDScale, setDScaleX, setDScaleY, setDScaleZ, setId, setLoc, setLocX, setLocY, setLocZ, setLookat, setQuat, setQuatW, setQuatX, setQuatY, setQuatZ, setRot, setRotMatrix, setRotOrder, setRotX, setRotY, setRotZ, setScale, setScaleX, setScaleY, setScaleZ, setStaticMatrix, setTransformMode, setUpAxis
Methods borrowed from class GLGE.QuickNotation:
_
Methods borrowed from class GLGE.JSONLoader:
getDownloadPriority, setDownloadPriority, setJSONSrc, setJSONString
Event Summary
Event Attributes Event Name and Description
 
childAdded(event)
 
childRemoved(event)
 
Events borrowed from class GLGE.Animatable:
animFinished
Events borrowed from class GLGE.Placeable:
appened, childMatrixUpdate, matrixUpdate, removed
Class Detail
GLGE.Group(uid)
Parameters:
uid
Method Detail
addChild(object)
Adds a new object to this group
Parameters:
{object} object
the object to add to this group

addParticleSystem(the)

Defined in: glge_particles.js.
Parameters:
{GLGE.ParticleSystem} the
particle system to add

downloadComplete()

{GLGE.BoundingVolume} getBoundingVolume(local)
Gets the bounding volume for this group
Parameters:
local
Returns:
{GLGE.BoundingVolume}

getChildren()
Gets an array of all children in this group

{GLGE.Lights[]} getLights(pointer)
Gets a list of all lights in this group
Parameters:
{array} pointer
to an array [optional]
Returns:
{GLGE.Lights[]} an array of GLGE.Lights

getNames(names)
Gets the name of the object and names of any sub objects
Parameters:
names
Returns:
an object of name

{GLGE.Object[]} getObjects(pointer)
Gets a list of all objects in this group
Parameters:
{array} pointer
to an array [optional]
Returns:
{GLGE.Object[]} an array of GLGE.Objects

getPickable()
Gets the pickable flag for the object

getVisible()
Gets the groups visibility
Returns:
flag to indicate the objects visibility

{boolean} isComplete()
Checks if resources have finished downloading
Returns:
{boolean}

removeChild(object)
Removes an object or sub group from this group
Parameters:
{object} object
the item to remove

setAction(action, blendTime, loop)
Sets the action for this Group
Parameters:
{GLGE.Action} action
the action to apply
blendTime
loop

setPickable(value)
Sets the pickable flag for the object
Parameters:
{boolean} value
the picking flag

setVisible(visable)
Sets the groups visibility
Parameters:
{boolean} visable
flag to indicate the objects visibility

updateAllPrograms()
Forces an update of all shaders and programs in this group
Event Detail
childAdded(event)
Parameters:
{object} event

childRemoved(event)
Parameters:
{object} event

downloadComplete(data)
Parameters:
{object} data

Documentation generated by JsDoc Toolkit 2.4.0 on Sun Feb 12 2012 14:20:23 GMT+0000 (GMT)