Fork me on GitHub

API Documentation


Extends GLGE.Animatable, GLGE.JSONLoader, GLGE.Placeable, GLGE.QuickNotation.
Text that can be rendered in a scene
Defined in: glge_text.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
GLGE.Text(uid)
Method Summary
Method Attributes Method Name and Description
 
Gets the alpha
 
Gets the current base color of the text
 
Gets the font of the text
 
Gets the pick type for this text
 
Gets the size of the text
 
Gets the rendered text
 
Gets the z transparency
 
Sets the alpha
 
setColor(color)
Sets the base colour of the text
 
Sets the blue base colour of the text
 
Sets the green base colour of the text
 
Sets the red base colour of the text
 
setFont(value)
Sets the font of the text
 
setPickType(value)
Sets the pick type GLGE.TEXT_BOXPICK for picking based on bound box or GLGE.TEXT_TEXTPICK for pixel perfect text picking
 
setSize(value)
Sets the size of the text
 
setText(value)
Sets the text to be rendered
 
Sets the Z Transparency of this text
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.Text(uid)
Parameters:
uid
Method Detail
getAlpha()
Gets the alpha
Returns:
The alpha level

{[r|g|b]} getColor()
Gets the current base color of the text
Returns:
{[r|g|b]} The current base color

{string} getFont()
Gets the font of the text
Returns:
{string} the font of the text

{string} getPickType()
Gets the pick type for this text
Returns:
{string} the pick type

{string} getSize()
Gets the size of the text
Returns:
{string} the size of the text

{string} getText()
Gets the rendered text
Returns:
{string} the text rendered

isZtransparent()
Gets the z transparency
Returns:
boolean

setAlpha(b)
Sets the alpha
Parameters:
{Number} b
The new alpha level 0-1

setColor(color)
Sets the base colour of the text
Parameters:
{string} color
The colour of the material

setColorB(b)
Sets the blue base colour of the text
Parameters:
{Number} b
The new blue level 0-1

setColorG(g)
Sets the green base colour of the text
Parameters:
{Number} g
The new green level 0-1

setColorR(r)
Sets the red base colour of the text
Parameters:
{Number} r
The new red level 0-1

setFont(value)
Sets the font of the text
Parameters:
{Number} value
the font of the text

setPickType(value)
Sets the pick type GLGE.TEXT_BOXPICK for picking based on bound box or GLGE.TEXT_TEXTPICK for pixel perfect text picking
Parameters:
{Number} value
the picking type

setSize(value)
Sets the size of the text
Parameters:
{Number} value
the size of the text

setText(value)
Sets the text to be rendered
Parameters:
{Number} value
the text to render

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

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