Fork me on GitHub

API Documentation

Abstract class to agument objects that requires position, rotation and scale.
Defined in: glge_placeable.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Clears the static matrix if one is set
 
Gets the x location displacement of the object
 
Gets the y location displacement of the object
 
Gets the z location displacement of the object
 
Gets the x rotaional displacement of the object
 
Gets the y rotaional displacement of the object
 
Gets the z rotaional displacement of the object
 
Gets the x scale displacement of the object
 
Gets the y scale displacement of the object
 
Gets the z scale displacement of the object
 
Gets the id string of this text
 
Gets the model inverse matrix to transform the model within the world
 
Gets the local transform matrix
 
Gets the x location of the object
 
Gets the y location of the object
 
Gets the z location of the object
 
getLookat(value)
gets the object or poisition being looking at
 
Gets the model matrix to transform the model within the world
 
Gets the position of the object
 
Gets the w quat of the rotation
 
Gets the x quat of the rotation
 
Gets the y quat of the rotation
 
Gets the z quat of the rotation
 
Gets the id string of this text
 
Gets the root node object
 
Gets the rotation of the object
 
Gets the rotaion matrix
 
Gets the euler rotation order
 
Gets the x rotation of the object
 
Gets the y rotation of the object
 
Gets the z rotation of the object
 
Gets the scale of the object
 
Gets the scale matrix
 
Gets the x scale of the object
 
Gets the y scale of the object
 
Gets the z scale of the object
 
Gets the translate matrix
 
Gets the model inverse transposed matrix to transform the model within the world
 
Gets the model transposed matrix to transform the model within the world
 
gets the up axis of the object
 
Lookat(value)
Points the object in the direction of the coords or placeable value
 
move(amount, reference)
Moves the object
 
setDLoc(x, y, z)
Sets the location displacement of the object, useful for animation
 
setDLocX(value)
Sets the x location displacement of the object, usefull for animation
 
setDLocY(value)
Sets the y location displacement of the object, usefull for animation
 
setDLocZ(value)
Sets the z location displacement of the object, usefull for animation
 
setDRot(x, y, z)
Sets the rotation displacement of the object, useful for animation
 
setDRotX(value)
Sets the x rotation displacement of the object, usefull for animation
 
setDRotY(value)
Sets the y rotation displacement of the object, usefull for animation
 
setDRotZ(value)
Sets the z rotation displacement of the object, usefull for animation
 
setDScale(x, y, z)
Sets the scale displacement of the object, useful for animation
 
setDScaleX(value)
Sets the x scale displacement of the object, usefull for animation
 
setDScaleY(value)
Sets the y scale displacement of the object, usefull for animation
 
setDScaleZ(value)
Sets the z scale displacement of the object, usefull for animation
 
setId(id)
Sets the id string
 
setLoc(x, y, z)
Sets the location of the object
 
setLocX(value)
Sets the x location of the object
 
setLocY(value)
Sets the y location of the object
 
setLocZ(value)
Sets the z location of the object
 
setLookat(value)
sets the look at for this object, will be updated every frame
 
setQuat(x, y, z, w)
Sets the quaternions
 
setQuatW(value)
Sets the w quat value
 
setQuatX(value)
Sets the x quat value
 
setQuatY(value)
Sets the y quat value
 
setQuatZ(value)
Sets the z quat value
 
setRot(x, y, z)
Sets the rotation of the object
 
Sets the rotation matrix
 
setRotOrder(value)
Sets the euler rotation order
 
setRotX(value)
Sets the x rotation of the object
 
setRotY(value)
Sets the y rotation of the object
 
setRotZ(value)
Sets the z rotation of the object
 
setScale(x, y, z)
Sets the scale of the object
 
setScaleX(value)
Sets the x scale of the object
 
setScaleY(value)
Sets the y scale of the object
 
setScaleZ(value)
Sets the z scale of the object
 
Sets a static transfrom matrix, overrides any rotations and translation that may be set
 
Sets the transform mode
 
setUpAxis(value)
sets the upAxis for this object
Event Summary
Event Attributes Event Name and Description
 
appened(event)
 
 
matrixUpdate(event)
 
removed(event)
Class Detail
GLGE.Placeable()
Method Detail
{object} clearStaticMatrix()
Clears the static matrix if one is set
Returns:
{object}

{number} getDLocX()
Gets the x location displacement of the object
Returns:
{number}

{number} getDLocY()
Gets the y location displacement of the object
Returns:
{number}

{number} getDLocZ()
Gets the z location displacement of the object
Returns:
{number}

{number} getDRotX()
Gets the x rotaional displacement of the object
Returns:
{number}

{number} getDRotY()
Gets the y rotaional displacement of the object
Returns:
{number}

{number} getDRotZ()
Gets the z rotaional displacement of the object
Returns:
{number}

{number} getDScaleX()
Gets the x scale displacement of the object
Returns:
{number}

{number} getDScaleY()
Gets the y scale displacement of the object
Returns:
{number}

{number} getDScaleZ()
Gets the z scale displacement of the object
Returns:
{number}

{string} getId()
Gets the id string of this text
Returns:
{string}

getInverseModelMatrix()
Gets the model inverse matrix to transform the model within the world

{object} getLocalMatrix()
Gets the local transform matrix
Returns:
{object}

{number} getLocX()
Gets the x location of the object
Returns:
{number}

{number} getLocY()
Gets the y location of the object
Returns:
{number}

{number} getLocZ()
Gets the z location of the object
Returns:
{number}

getLookat(value)
gets the object or poisition being looking at
Parameters:
{array|object} value
the location/object

getModelMatrix()
Gets the model matrix to transform the model within the world

{array} getPosition()
Gets the position of the object
Returns:
{array}

{number} getQuatW()
Gets the w quat of the rotation
Returns:
{number}

{number} getQuatX()
Gets the x quat of the rotation
Returns:
{number}

{number} getQuatY()
Gets the y quat of the rotation
Returns:
{number}

{number} getQuatZ()
Gets the z quat of the rotation
Returns:
{number}

{string} getRef()
Gets the id string of this text
Returns:
{string}

{object} getRoot()
Gets the root node object
Returns:
{object}

{object} getRotation()
Gets the rotation of the object
Returns:
{object}

{matrix} getRotMatrix()
Gets the rotaion matrix
Returns:
{matrix} the objects rotation matrix

{number} getRotOrder()
Gets the euler rotation order
Returns:
{number} the objects rotation matrix

{number} getRotX()
Gets the x rotation of the object
Returns:
{number}

{number} getRotY()
Gets the y rotation of the object
Returns:
{number}

{number} getRotZ()
Gets the z rotation of the object
Returns:
{number}

{object} getScale()
Gets the scale of the object
Returns:
{object}

{object} getScaleMatrix()
Gets the scale matrix
Returns:
{object}

{number} getScaleX()
Gets the x scale of the object
Returns:
{number}

{number} getScaleY()
Gets the y scale of the object
Returns:
{number}

{number} getScaleZ()
Gets the z scale of the object
Returns:
{number}

{object} getTranslateMatrix()
Gets the translate matrix
Returns:
{object}

getTransposeInverseModelMatrix()
Gets the model inverse transposed matrix to transform the model within the world

getTransposeModelMatrix()
Gets the model transposed matrix to transform the model within the world

getUpAxis()
gets the up axis of the object

Lookat(value)
Points the object in the direction of the coords or placeable value
Parameters:
{array|object} value
the location/objec to look at

{array, number} move(amount, reference)
Moves the object
Parameters:
amount
reference
Returns:
{array} amount array [x,y,z] to move
{number} reference move with respecct to GLGE.GLOBAL or GLGE.LOCAL

setDLoc(x, y, z)
Sets the location displacement of the object, useful for animation
Parameters:
{number} x
The value to assign to the x position
{number} y
The value to assign to the y position
{number} z
The value to assign to the z position

setDLocX(value)
Sets the x location displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the x displacement

setDLocY(value)
Sets the y location displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the y displacement

setDLocZ(value)
Sets the z location displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the z displacement

setDRot(x, y, z)
Sets the rotation displacement of the object, useful for animation
Parameters:
{number} x
The value to assign to the x rotation
{number} y
The value to assign to the y rotation
{number} z
The value to assign to the z rotation

setDRotX(value)
Sets the x rotation displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the x displacement

setDRotY(value)
Sets the y rotation displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the y displacement

setDRotZ(value)
Sets the z rotation displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the z displacement

setDScale(x, y, z)
Sets the scale displacement of the object, useful for animation
Parameters:
{number} x
The value to assign to the x scale
{number} y
The value to assign to the y scale
{number} z
The value to assign to the z scale

setDScaleX(value)
Sets the x scale displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the x displacement

setDScaleY(value)
Sets the y scale displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the y displacement

setDScaleZ(value)
Sets the z scale displacement of the object, usefull for animation
Parameters:
{number} value
The value to assign to the z displacement

setId(id)
Sets the id string
Parameters:
{string} id
The id string

setLoc(x, y, z)
Sets the location of the object
Parameters:
{number} x
The value to assign to the x position
{number} y
The value to assign to the y position
{number} z
The value to assign to the z position

setLocX(value)
Sets the x location of the object
Parameters:
{number} value
The value to assign to the x position

setLocY(value)
Sets the y location of the object
Parameters:
{number} value
The value to assign to the y position

setLocZ(value)
Sets the z location of the object
Parameters:
{number} value
The value to assign to the z position

setLookat(value)
sets the look at for this object, will be updated every frame
Parameters:
{array|object} value
the location/objec to look at

setQuat(x, y, z, w)
Sets the quaternions
Parameters:
{number} x
The value to assign to the x
{number} y
The value to assign to the y
{number} z
The value to assign to the z
{number} w
The value to assign to the w

setQuatW(value)
Sets the w quat value
Parameters:
{number} value
the w quat value

setQuatX(value)
Sets the x quat value
Parameters:
{number} value
the x quat value

setQuatY(value)
Sets the y quat value
Parameters:
{number} value
the y quat value

setQuatZ(value)
Sets the z quat value
Parameters:
{number} value
the z quat value

setRot(x, y, z)
Sets the rotation of the object
Parameters:
{number} x
The value to assign to the x rotation
{number} y
The value to assign to the y rotation
{number} z
The value to assign to the z rotation

setRotMatrix(the)
Sets the rotation matrix
Parameters:
{matrix} the
objects rotation matrix

setRotOrder(value)
Sets the euler rotation order
Parameters:
{number} value
the order to rotate GLGE.ROT_XYZ,GLGE.ROT_XZY,etc..

setRotX(value)
Sets the x rotation of the object
Parameters:
{number} value
The value to assign to the x rotation

setRotY(value)
Sets the y rotation of the object
Parameters:
{number} value
The value to assign to the y rotation

setRotZ(value)
Sets the z rotation of the object
Parameters:
{number} value
The value to assign to the z rotation

setScale(x, y, z)
Sets the scale of the object
Parameters:
{number} x
The value to assign to the x scale
{number} y
The value to assign to the y scale
{number} z
The value to assign to the z scale

setScaleX(value)
Sets the x scale of the object
Parameters:
{number} value
The value to assign to the x scale

setScaleY(value)
Sets the y scale of the object
Parameters:
{number} value
The value to assign to the y scale

setScaleZ(value)
Sets the z scale of the object
Parameters:
{number} value
The value to assign to the z scale

{object} setStaticMatrix(matrix)
Sets a static transfrom matrix, overrides any rotations and translation that may be set
Parameters:
matrix
Returns:
{object}

setTransformMode(value)
Sets the transform mode
Parameters:
{mode} value
the transform mode

setUpAxis(value)
sets the upAxis for this object
Parameters:
{array} value
the up axis for the object
Event Detail
appened(event)
Parameters:
{object} event

childMatrixUpdate(event)
Parameters:
{object} event

matrixUpdate(event)
Parameters:
{object} event

removed(event)
Parameters:
{object} event

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