Moai SDK  2.0
MOAITransformBase Class Reference
+ Inheritance diagram for MOAITransformBase:

Function List

getWorldDir
 
getWorldLoc
 
getWorldRot
 
getWorldScl
 
getWorldXAxis
 
getWorldYAxis
 
getWorldZAxis
 
getWorldXNormal
 
getWorldYNormal
 
getWorldZNormal
 
modelToWorld
 
setParent
 
worldToModel
 

Additional Inherited Members

- Function List inherited from MOAINode
clearAttrLink
 
clearNodeLink
 
forceUpdate
 
getAttr
 
getAttrLink
 
getNodeState
 
moveAttr
 
scheduleUpdate
 
seekAttr
 
setAttrLink
 
setAttr
 
setNodeLink
 
- Function List inherited from MOAIInstanceEventSource
getListener
 
setListener
 

Detailed Description

Attributes
MOAITransformBase.ATTR_WORLD_X_LOC
MOAITransformBase.ATTR_WORLD_Y_LOC
MOAITransformBase.ATTR_WORLD_Z_LOC
MOAITransformBase.ATTR_WORLD_Z_ROT
MOAITransformBase.ATTR_WORLD_X_SCL
MOAITransformBase.ATTR_WORLD_Y_SCL
MOAITransformBase.ATTR_WORLD_Z_SCL
MOAITransformBase.TRANSFORM_TRAIT

Function Documentation

getWorldDir

Returns the normalized direction vector of the transform. This value is returned in world space so includes parent transforms (if any).


function getWorldDir ( MOAITransformBase self )

Parameters
MOAITransformBaseself
Returns
number xDirection, number yDirection, number zDirection
getWorldLoc

Get the transform's location in world space.


function getWorldLoc ( MOAITransformBase self )

Parameters
MOAITransformBaseself
Returns
number xLoc, number yLoc, number zLoc
getWorldRot

Get the transform's rotation in world space.


function getWorldRot ( MOAITransformBase self )

Parameters
MOAITransformBaseself
Returns
number degrees
getWorldScl

Get the transform's scale in world space.


function getWorldScl ( MOAITransformBase self )

Parameters
MOAITransformBaseself
Returns
number xScale, number yScale, number zScale
getWorldXAxis

Return the X axis of the coordinate system (includes scale);.


function getWorldXAxis ( MOAITransform self )

Parameters
MOAITransformself
Returns
number x, number y, number z
getWorldXNormal

Return the X axis of the coordinate system (normalized);.


function getWorldXNormal ( MOAITransform self [, number length ] )

Parameters
MOAITransformself
numberlength Optional.
Returns
number x, number y, number z
getWorldYAxis

Return the Y axis of the coordinate system (includes scale);.


function getWorldXAxis ( MOAITransform self )

Parameters
MOAITransformself
Returns
number x, number y, number z
getWorldYNormal

Return the Y axis of the coordinate system (normalized);.


function getWorldYNormal ( MOAITransform self [, number length ] )

Parameters
MOAITransformself
numberlength Optional.
Returns
number x, number y, number z
getWorldZAxis

Return the Z axis of the coordinate system (includes scale);.


function getWorldXAxis ( MOAITransform self )

Parameters
MOAITransformself
Returns
number x, number y, number z
getWorldZNormal

Return the Z axis of the coordinate system (normalized);.


function getWorldZNormal ( MOAITransform self [, number length ] )

Parameters
MOAITransformself
numberlength Optional.
Returns
number x, number y, number z
modelToWorld

Transform a point in model space to world space.


function modelToWorld ( MOAITransform self [, number x, number y, number z, number w ] )

Parameters
MOAITransformself
numberx Optional. Default value is 0.
numbery Optional. Default value is 0.
numberz Optional. Default value is 0.
numberw Optional. Default value is 1.
Returns
number x, number y, number z, number w
setParent

This method has been deprecated. Use MOAINode setAttrLink instead.


function setParent ( MOAITransformBase self [, MOAINode parent ] )

Parameters
MOAITransformBaseself
MOAINodeparent Optional. Default value is nil.
Returns
nil
worldToModel

Transform a point in world space to model space.


function worldToModel ( MOAITransform self [, number x, number y, number z, number w ] )

Parameters
MOAITransformself
numberx Optional. Default value is 0.
numbery Optional. Default value is 0.
numberz Optional. Default value is 0.
numberw Optional. Default value is 1.
Returns
number x, number y, number z, number w