Moai SDK  1.5 revision 1 (MoaiEdition)
Function List
MOAITransform Class Reference
Inheritance diagram for MOAITransform:
MOAITransformBase MOAINode MOAIInstanceEventSource MOAIEventSource MOAICamera MOAIFmodEventInstance MOAIFmodMicrophone MOAILayerBridge MOAIParticleEmitter MOAIParticleForce MOAIProp MOAIProp MOAIScissorRect

List of all members.

Function List

  addLoc
  addPiv
  addRot
  addScl
  getLoc
  getPiv
  getRot
  getScl
  modelToWorld
  move
  moveLoc
  movePiv
  moveRot
  moveScl
  seek
  seekLoc
  seekPiv
  seekRot
  seekScl
  setLoc
  setParent
  setPiv
  setRot
  setScl
  setShearByX
  setShearByY
  setShearByZ
  worldToModel

Function Documentation

addLoc

Adds a delta to the transform's location.

function addLoc ( MOAITransform self, number xDelta, number yDelta, number zDelta )
Parameters:
self ( MOAITransform )
xDelta ( number )
yDelta ( number )
zDelta ( number )
Returns:
nil
addPiv

Adds a delta to the transform's pivot.

function addPiv ( MOAITransform self, number xDelta, number yDelta, number zDelta )
Parameters:
self ( MOAITransform )
xDelta ( number )
yDelta ( number )
zDelta ( number )
Returns:
nil
addRot

Adds a delta to the transform's rotation.

function addRot ( MOAITransform self, number xDelta, number yDelta, number zDelta )
Parameters:
self ( MOAITransform )
xDelta ( number ) In degrees.
yDelta ( number ) In degrees.
zDelta ( number ) In degrees.
Returns:
nil
addScl

Adds a delta to the transform's scale.

function addScl ( MOAITransform self, number xSclDelta [, number ySclDelta, number zSclDelta ] )
Parameters:
self ( MOAITransform )
xSclDelta ( number )
ySclDelta ( number ) Optional. Default value is xSclDelta.
zSclDelta ( number ) Optional. Default value is 0.
Returns:
nil
getLoc

Returns the transform's current location.

function getLoc ( MOAITransform self )
Parameters:
self ( MOAITransform )
Returns:
xLoc ( number ), yLoc ( number ), zLoc ( number )
getPiv

Returns the transform's current pivot.

function getPiv ( MOAITransform self )
Parameters:
self ( MOAITransform )
Returns:
xPiv ( number ), yPiv ( number ), zPiv ( number )
getRot

Returns the transform's current rotation.

function getRot ( MOAITransform self )
Parameters:
self ( MOAITransform )
Returns:
xRot ( number ), yRot ( number ), zRot ( number )
getScl

Returns the transform's current scale.

function getScl ( MOAITransform self )
Parameters:
self ( MOAITransform )
Returns:
xScl ( number ), yScl ( number ), zScl ( number )
modelToWorld

Transform a point in model space to world space.

function modelToWorld ( MOAITransform self [, number x, number y, number z ] )
Parameters:
self ( MOAITransform )
x ( number ) Optional. Default value is 0.
y ( number ) Optional. Default value is 0.
z ( number ) Optional. Default value is 0.
Returns:
x ( number ), y ( number ), z ( number )
move

Animate the transform by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function move ( MOAITransform self, number xDelta, number yDelta, number zDelta, number xRotDelta, number yRotDelta, number zRotDelta, number xSclDelta, number ySclDelta, number zSclDelta, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xDelta ( number ) Delta to be added to x.
yDelta ( number ) Delta to be added to y.
zDelta ( number ) Delta to be added to z.
xRotDelta ( number ) Delta to be added to x rot (in degrees).
yRotDelta ( number ) Delta to be added to y rot (in degrees).
zRotDelta ( number ) Delta to be added to z rot (in degrees).
xSclDelta ( number ) Delta to be added to x scale.
ySclDelta ( number ) Delta to be added to y scale.
zSclDelta ( number ) Delta to be added to z scale.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
moveLoc

Animate the transform by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function moveLoc ( MOAITransform self, number xDelta, number yDelta, number zDelta, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xDelta ( number ) Delta to be added to x.
yDelta ( number ) Delta to be added to y.
zDelta ( number ) Delta to be added to z.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
movePiv

Animate the transform by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function movePiv ( MOAITransform self, number xDelta, number yDelta, number zDelta, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xDelta ( number ) Delta to be added to xPiv.
yDelta ( number ) Delta to be added to yPiv.
zDelta ( number ) Delta to be added to zPiv.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
moveRot

Animate the transform by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function moveRot ( MOAITransform self, number xDelta, number yDelta, number zDelta, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xDelta ( number ) Delta to be added to xRot (in degrees).
yDelta ( number ) Delta to be added to yRot (in degrees).
zDelta ( number ) Delta to be added to zRot (in degrees).
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
moveScl

Animate the transform by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function moveScl ( MOAITransform self, number xSclDelta, number ySclDelta, number zSclDelta, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xSclDelta ( number ) Delta to be added to x scale.
ySclDelta ( number ) Delta to be added to y scale.
zSclDelta ( number ) Delta to be added to z scale.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
seek

Animate the transform by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function seek ( MOAITransform self, number xGoal, number yGoal, number zGoal, number xRotGoal, number yRotGoal, number zRotGoal, number xSclGoal, number ySclGoal, number zSclGoal, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xGoal ( number ) Desired resulting value for x.
yGoal ( number ) Desired resulting value for y.
zGoal ( number ) Desired resulting value for z.
xRotGoal ( number ) Desired resulting value for x rot (in degrees).
yRotGoal ( number ) Desired resulting value for y rot (in degrees).
zRotGoal ( number ) Desired resulting value for z rot (in degrees).
xSclGoal ( number ) Desired resulting value for x scale.
ySclGoal ( number ) Desired resulting value for y scale.
zSclGoal ( number ) Desired resulting value for z scale.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
seekLoc

Animate the transform by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function seekLoc ( MOAITransform self, number xGoal, number yGoal, number zGoal, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xGoal ( number ) Desired resulting value for x.
yGoal ( number ) Desired resulting value for y.
zGoal ( number ) Desired resulting value for z.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
seekPiv

Animate the transform by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function seekPiv ( MOAITransform self, number xGoal, number yGoal, number zGoal, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xGoal ( number ) Desired resulting value for xPiv.
yGoal ( number ) Desired resulting value for yPiv.
zGoal ( number ) Desired resulting value for zPiv.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
seekRot

Animate the transform by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function seekRot ( MOAITransform self, number xRotGoal, number yRotGoal, number zRotGoal, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xRotGoal ( number ) Desired resulting value for x rot (in degrees).
yRotGoal ( number ) Desired resulting value for y rot (in degrees).
zRotGoal ( number ) Desired resulting value for z rot (in degrees).
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
seekScl

Animate the transform by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

function seekScl ( MOAITransform self, number xSclGoal, number ySclGoal, number zSclGoal, number length [, number mode ] )
Parameters:
self ( MOAITransform )
xSclGoal ( number ) Desired resulting value for x scale.
ySclGoal ( number ) Desired resulting value for y scale.
zSclGoal ( number ) Desired resulting value for z scale.
length ( number ) Length of animation in seconds.
mode ( number ) Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.
Returns:
easeDriver ( MOAIEaseDriver )
setLoc

Sets the transform's location.

function setLoc ( MOAITransform self [, number x, number y, number z ] )
Parameters:
self ( MOAITransform )
x ( number ) Optional. Default value is 0.
y ( number ) Optional. Default value is 0.
z ( number ) Optional. Default value is 0.
Returns:
nil
setParent

This method has been deprecated. Use MOAINode setAttrLink instead.

function setParent ( MOAITransform self [, MOAINode parent ] )
Parameters:
self ( MOAITransform )
parent ( MOAINode ) Optional. Default value is nil.
Returns:
nil

Reimplemented in MOAIProp, and MOAIProp.

setPiv

Sets the transform's pivot.

function setPiv ( MOAITransform self [, number xPiv, number yPiv, number zPiv ] )
Parameters:
self ( MOAITransform )
xPiv ( number ) Optional. Default value is 0.
yPiv ( number ) Optional. Default value is 0.
zPiv ( number ) Optional. Default value is 0.
Returns:
nil
setRot

Sets the transform's rotation.

function setRot ( MOAITransform self [, number xRot, number yRot, number zRot ] )
Parameters:
self ( MOAITransform )
xRot ( number ) Optional. Default value is 0.
yRot ( number ) Optional. Default value is 0.
zRot ( number ) Optional. Default value is 0.
Returns:
nil
setScl

Sets the transform's scale.

function setScl ( MOAITransform self, number xScl [, number yScl, number zScl ] )
Parameters:
self ( MOAITransform )
xScl ( number )
yScl ( number ) Optional. Default value is xScl.
zScl ( number ) Optional. Default value is 1.
Returns:
nil
setShearByX

Sets the shear for the Y and Z axes by X.

function setShearByX ( MOAITransform self, number yx [, number zx ] )
Parameters:
self ( MOAITransform )
yx ( number ) Default value is 0.
zx ( number ) Optional. Default value is 0.
Returns:
nil
setShearByY

Sets the shear for the X and Z axes by Y.

function setShearByY ( MOAITransform self, number xy [, number zy ] )
Parameters:
self ( MOAITransform )
xy ( number ) Default value is 0.
zy ( number ) Optional. Default value is 0.
Returns:
nil
setShearByZ

Sets the shear for the X and Y axes by Z.

function setShearByZ ( MOAITransform self, number xz [, number yz ] )
Parameters:
self ( MOAITransform )
xz ( number ) Default value is 0.
yz ( number ) Optional. Default value is 0.
Returns:
nil
worldToModel

Transform a point in world space to model space.

function worldToModel ( MOAITransform self [, number x, number y, number z ] )
Parameters:
self ( MOAITransform )
x ( number ) Optional. Default value is 0.
y ( number ) Optional. Default value is 0.
z ( number ) Optional. Default value is 0.
Returns:
x ( number ), y ( number ), z ( number )