Moai SDK: MOAITransform Class Reference

Moai SDK 2.0

Inheritance diagram for MOAITransform:

Function List
	addLoc

	addPiv

	addRot

	addScl

	getLoc

	getPiv

	getRot

	getScl

	move

	moveLoc

	movePiv

	moveRot

	moveScl

	seek

	seekLoc

	seekPiv

	seekRot

	seekScl

	setLoc

	setPiv

	setRot

	setScl

	setShearByX

	setShearByY

	setShearByZ

Function List inherited from MOAITransformBase
	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

MOAITransform.ATTR_X_PIV

MOAITransform.ATTR_Y_PIV

MOAITransform.ATTR_Z_PIV

MOAITransform.ATTR_X_LOC

MOAITransform.ATTR_Y_LOC

MOAITransform.ATTR_Z_LOC

MOAITransform.ATTR_X_ROT

MOAITransform.ATTR_Y_ROT

MOAITransform.ATTR_Z_ROT

MOAITransform.ATTR_X_SCL

MOAITransform.ATTR_Y_SCL

MOAITransform.ATTR_Z_SCL

MOAITransform.ATTR_ROTATE_QUAT

MOAITransform.ATTR_TRANSLATE

MOAITransform.INHERIT_LOC

MOAITransform.INHERIT_TRANSFORM

Function Documentation

addLoc

Adds a delta to the transform's location.

function addLoc ( MOAITransform self, number xDelta, number yDelta, number zDelta )

Parameters

MOAITransform	self
number	xDelta
number	yDelta
number	zDelta

Returns: nil

addPiv

Adds a delta to the transform's pivot.

function addPiv ( MOAITransform self, number xDelta, number yDelta, number zDelta )

Parameters

MOAITransform	self
number	xDelta
number	yDelta
number	zDelta

Returns: nil

addRot

Adds a delta to the transform's rotation.

function addRot ( MOAITransform self, number xDelta, number yDelta, number zDelta )

Parameters

MOAITransform	self
number	xDelta In degrees.
number	yDelta In degrees.
number	zDelta In degrees.

Returns: nil

addScl

Adds a delta to the transform's scale.

function addScl ( MOAITransform self, number xSclDelta [, number ySclDelta, number zSclDelta ] )

Parameters

MOAITransform	self
number	xSclDelta
number	ySclDelta Optional. Default value is xSclDelta.
number	zSclDelta Optional. Default value is 0.

Returns: nil

getLoc

Returns the transform's current location.

function getLoc ( MOAITransform self )

Parameters

MOAITransform self

Returns: number xLoc, number yLoc, number zLoc

getPiv

Returns the transform's current pivot.

function getPiv ( MOAITransform self )

Parameters

MOAITransform self

Returns: number xPiv, number yPiv, number zPiv

getRot

Returns the transform's current rotation.

function getRot ( MOAITransform self )

Parameters

MOAITransform self

Returns: number xRot, number yRot, number zRot

getScl

Returns the transform's current scale.

function getScl ( MOAITransform self )

Parameters

MOAITransform self

Returns: number xScl, number yScl, number zScl

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

MOAITransform	self
number	xDelta Delta to be added to x.
number	yDelta Delta to be added to y.
number	zDelta Delta to be added to z.
number	xRotDelta Delta to be added to x rot (in degrees).
number	yRotDelta Delta to be added to y rot (in degrees).
number	zRotDelta Delta to be added to z rot (in degrees).
number	xSclDelta Delta to be added to x scale.
number	ySclDelta Delta to be added to y scale.
number	zSclDelta Delta to be added to z scale.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xDelta Delta to be added to x.
number	yDelta Delta to be added to y.
number	zDelta Delta to be added to z.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xDelta Delta to be added to xPiv.
number	yDelta Delta to be added to yPiv.
number	zDelta Delta to be added to zPiv.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xDelta Delta to be added to xRot (in degrees).
number	yDelta Delta to be added to yRot (in degrees).
number	zDelta Delta to be added to zRot (in degrees).
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xSclDelta Delta to be added to x scale.
number	ySclDelta Delta to be added to y scale.
number	zSclDelta Delta to be added to z scale.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xGoal Desired resulting value for x.
number	yGoal Desired resulting value for y.
number	zGoal Desired resulting value for z.
number	xRotGoal Desired resulting value for x rot (in degrees).
number	yRotGoal Desired resulting value for y rot (in degrees).
number	zRotGoal Desired resulting value for z rot (in degrees).
number	xSclGoal Desired resulting value for x scale.
number	ySclGoal Desired resulting value for y scale.
number	zSclGoal Desired resulting value for z scale.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xGoal Desired resulting value for x.
number	yGoal Desired resulting value for y.
number	zGoal Desired resulting value for z.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xGoal Desired resulting value for xPiv.
number	yGoal Desired resulting value for yPiv.
number	zGoal Desired resulting value for zPiv.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xRotGoal Desired resulting value for x rot (in degrees).
number	yRotGoal Desired resulting value for y rot (in degrees).
number	zRotGoal Desired resulting value for z rot (in degrees).
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

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

MOAITransform	self
number	xSclGoal Desired resulting value for x scale.
number	ySclGoal Desired resulting value for y scale.
number	zSclGoal Desired resulting value for z scale.
number	length Length of animation in seconds.
number	mode 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: MOAIEaseDriver easeDriver

setLoc

Sets the transform's location.

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

Parameters

MOAITransform	self
number	x Optional. Default value is 0.
number	y Optional. Default value is 0.
number	z Optional. Default value is 0.

Returns: nil

setPiv

Sets the transform's pivot.

function setPiv ( MOAITransform self [, number xPiv, number yPiv, number zPiv ] )

Parameters

MOAITransform	self
number	xPiv Optional. Default value is 0.
number	yPiv Optional. Default value is 0.
number	zPiv Optional. Default value is 0.

Returns: nil

setRot

Sets the transform's rotation.

function setRot ( MOAITransform self [, number xRot, number yRot, number zRot ] )

Parameters

MOAITransform	self
number	xRot Optional. Default value is 0.
number	yRot Optional. Default value is 0.
number	zRot Optional. Default value is 0.

Returns: nil

setScl

Sets the transform's scale.

function setScl ( MOAITransform self, number xScl [, number yScl, number zScl ] )

Parameters

MOAITransform	self
number	xScl
number	yScl Optional. Default value is xScl.
number	zScl 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

MOAITransform	self
number	yx Default value is 0.
number	zx 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

MOAITransform	self
number	xy Default value is 0.
number	zy 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

MOAITransform	self
number	xz Default value is 0.
number	yz Optional. Default value is 0.

Returns: nil

MOAITransform
Generated on Sun Oct 15 2017 22:41:30 for Moai SDK by 1.8.9.1