Fork me on GitHub

API Documentation


Extends GLGE.Animatable, GLGE.JSONLoader, GLGE.Placeable, GLGE.QuickNotation.
An object that can be rendered in a scene
Defined in: glge_object.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
addMultiMaterial(multimaterial)
Adds another material to this object
 
 
 
Gets the the show casting flag
 
Gets the culling flag for the object
 
Gets the depth test flag for the object
 
Gets the objects draw type
 
Gets the objects line width
 
Gets the material associated with the object
 
getMesh(idx)
Gets the mesh associated with the object
 
Gets blending between frames
 
gets all of the objects materials and meshes
 
Gets the pickable flag for the object
 
Gets the objects draw point size
 
Gets the objects skeleton
 
getUniform(name)
Gets the value of a custom uniform
 
Gets the type of a custom uniform
 
Gets the glsl code injected into the vertex shader of this object
 
Gets the object visibility
 
Checks if resources have finished downloading
 
Gets the z transparency
 
Sets the the show casting flag
 
setCull(value)
Sets the culling flag for the object
 
setDepthTest(value)
Sets the depth test flag for the object
 
setDrawType(value)
Sets the objects draw type
 
setLineWidth(value)
Sets the objects line width
 
Sets the material associated with the object
 
setMesh(idx)
Sets the mesh associated with the object
 
blending between frames
 
Sets the first mesh frame to use when using an animated mesh
 
Sets the second mesh frame to use when using an animated mesh
 
setPickable(value)
Sets the pickable flag for the object
 
setPointSize(value)
Sets the objects draw points size
 
setSkeleton(value)
Sets the objects skeleton
 
setUniform(type, name, value)
Sets a custom usinform on this object
 
Sets the code to inject into the vertex shader
 
setVisible(visable)
Sets the object visibility
 
Sets the Z Transparency of this object
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
 
 
willRender(data)
Events borrowed from class GLGE.Animatable:
animFinished
Events borrowed from class GLGE.Placeable:
appened, childMatrixUpdate, matrixUpdate, removed
Class Detail
GLGE.Object(uid)
Parameters:
uid
Method Detail
addMultiMaterial(multimaterial)
Adds another material to this object
Parameters:
multimaterial
Returns:
GLGE.Material

downloadComplete()

getBoundingVolume(local)
Parameters:
local

getCastShadows()
Gets the the show casting flag
Returns:
boolean

getCull()
Gets the culling flag for the object

getDepthTest()
Gets the depth test flag for the object

getDrawType()
Gets the objects draw type

getLineWidth()
Gets the objects line width

getMaterial(idx)
Gets the material associated with the object
Parameters:
idx
Returns:
GLGE.Material

getMesh(idx)
Gets the mesh associated with the object
Parameters:
idx
Returns:
GLGE.Mesh

getMeshBlendFactor()
Gets blending between frames
Returns:
blender factor

getMultiMaterials()
gets all of the objects materials and meshes
Returns:
array of GLGE.MultiMaterial objects

getPickable()
Gets the pickable flag for the object

getPointSize()
Gets the objects draw point size

getSkeleton()
Gets the objects skeleton
Returns:
GLGE.Group

{number} getUniform(name)
Gets the value of a custom uniform
Parameters:
{string} name
the name of the uniform to return
Returns:
{number} the value of the uniform

{number} getUniformType(name)
Gets the type of a custom uniform
Parameters:
{string} name
the name of the uniform to return
Returns:
{number} the type of the uniform

{string} getVertexShaderInjection(shader)
Gets the glsl code injected into the vertex shader of this object
Parameters:
shader
Returns:
{string} shader the glsl code injected into the vertex shader of this object

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

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

isZtransparent()
Gets the z transparency
Returns:
boolean

setCastShadows(value)
Sets the the show casting flag
Parameters:
{boolean} value
cast or not

setCull(value)
Sets the culling flag for the object
Parameters:
{boolean} value
the culling flag

setDepthTest(value)
Sets the depth test flag for the object
Parameters:
{boolean} value
the culling flag

setDrawType(value)
Sets the objects draw type
Parameters:
{GLGE.number} value
the draw type of this object

setLineWidth(value)
Sets the objects line width
Parameters:
{GLGE.number} value
the line width

setMaterial(idx)
Sets the material associated with the object
Parameters:
GLGE.Material
idx

setMesh(idx)
Sets the mesh associated with the object
Parameters:
GLGE.Mesh
idx

setMeshBlendFactor(frame)
blending between frames
Parameters:
{boolean} frame
value 0-1 morth between frame1 and frame2

setMeshFrame1(frame)
Sets the first mesh frame to use when using an animated mesh
Parameters:
{boolean} frame
the inital frame

setMeshFrame2(frame)
Sets the second mesh frame to use when using an animated mesh
Parameters:
{boolean} frame
the final frame

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

setPointSize(value)
Sets the objects draw points size
Parameters:
{GLGE.number} value
the point size to render

setSkeleton(value)
Sets the objects skeleton
Parameters:
{GLGE.Group} value
the skeleton group to set

setUniform(type, name, value)
Sets a custom usinform on this object
Parameters:
{string} type
the uniform type eg 1i, 3fv, Matrix4fv, etc
{string} name
the uniform name
{array} value
the value of the uniform

setVertexShaderInjection(shader)
Sets the code to inject into the vertex shader
Parameters:
{string} shader
the glsl code to inject into the vertex shader of this object GLGE will call the function GLGE_Position(vec4 position) to modify the position

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

setZtransparent(value)
Sets the Z Transparency of this object
Parameters:
{boolean} value
Does this object need blending?
Event Detail
downloadComplete(data)
Parameters:
{object} data

willRender(data)
Parameters:
{object} data

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