Fork me on GitHub

API Documentation


Extends GLGE.Animatable, GLGE.JSONLoader, GLGE.Placeable, GLGE.QuickNotation.
Creates a new camera object
Defined in: glge_camera.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GLGE.Camera(uid)
Method Summary
Method Attributes Method Name and Description
 
getAspect()
Method gets the current aspect if the camera type is GLGE.C_PERSPECTIVE
 
getFar()
Method gets the far drawing distance
 
getFovY()
Method gets the current yfov if the camera type is GLGE.C_PERSPECTIVE
 
getNear()
Method gets the near drawing distance
 
getOrthoScale()
Method gets the orthographic scale for the camers
 
getProjectionMatrix()
Method gets the current projection matrix of this camera
 
getType()
Method gets the current camera type
 
getViewMatrix()
Method generates the cameras view matrix
 
getViewProjection()
Method generates the cameras view projection matrix
 
setAspect(aspect)
Method sets the aspect of the camera
 
setCustomProjectionMatrix(projection)
Method sets a custom projection matrix
 
setFar(distance)
Method sets the far draw distance of the camera
 
setFovY(yfov)
Method sets the yfov of the camera
 
setNear(distance)
Method sets the near draw distance of the camera
 
setOrthoScale(scale)
Method sets the orthographic scale for the camers
 
setProjectionMatrix(projection)
Method generates the projection matrix based on the camera paramaters
 
setType(type)
Method sets the type of camera GLGE.C_PERSPECTIVE or GLGE.C_ORTHO
 
updateMatrix()
Method generates the cameras view matrix
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
Events borrowed from class GLGE.Animatable:
animFinished
Events borrowed from class GLGE.Placeable:
appened, childMatrixUpdate, matrixUpdate, removed
Class Detail
GLGE.Camera(uid)
Parameters:
uid
Method Detail
{Matrix} getAspect()
Method gets the current aspect if the camera type is GLGE.C_PERSPECTIVE
Returns:
{Matrix} Returns the yfov
{Matrix} getFar()
Method gets the far drawing distance
Returns:
{Matrix} Returns the cameras far draw distance
{Matrix} getFovY()
Method gets the current yfov if the camera type is GLGE.C_PERSPECTIVE
Returns:
{Matrix} Returns the yfov
{Matrix} getNear()
Method gets the near drawing distance
Returns:
{Matrix} Returns the cameras near draw distance
{Matrix} getOrthoScale()
Method gets the orthographic scale for the camers
Returns:
{Matrix} Returns the orthographic scale
{Matrix} getProjectionMatrix()
Method gets the current projection matrix of this camera
Returns:
{Matrix} Returns the camera projection matrix
{Matrix} getType()
Method gets the current camera type
Returns:
{Matrix} Returns the camera type
{Matrix} getViewMatrix()
Method generates the cameras view matrix
Returns:
Returns the view matrix based on this camera
{Matrix} getViewProjection()
Method generates the cameras view projection matrix
Returns:
Returns the view projection matrix based on this camera
setAspect(aspect)
Method sets the aspect of the camera
Parameters:
{number} aspect
The new projection matrix
setCustomProjectionMatrix(projection)
Method sets a custom projection matrix
Parameters:
{Matrix} projection
The new projection matrix
setFar(distance)
Method sets the far draw distance of the camera
Parameters:
{number} distance
The far draw distance
setFovY(yfov)
Method sets the yfov of the camera
Parameters:
{number} yfov
The new yfov of the camera
setNear(distance)
Method sets the near draw distance of the camera
Parameters:
{number} distance
The near draw distance
setOrthoScale(scale)
Method sets the orthographic scale for the camers
Parameters:
{number} scale
The new orthographic scale
setProjectionMatrix(projection)
Method generates the projection matrix based on the camera paramaters
Parameters:
{Matrix} projection
The new projection matrix
setType(type)
Method sets the type of camera GLGE.C_PERSPECTIVE or GLGE.C_ORTHO
Parameters:
{number} type
The type of this camera
{Matrix} updateMatrix()
Method generates the cameras view matrix
Returns:
Returns the view matrix based on this camera
Documentation generated by JsDoc Toolkit 2.4.0 on Sun Feb 12 2012 14:20:23 GMT+0000 (GMT)