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

Function List

getFarPlane
 
getFieldOfView
 
getFloorMove
 
getFocalLength
 
getNearPlane
 
getViewVector
 
lookAt
 
moveFieldOfView
 
seekFieldOfView
 
setFarPlane
 
setFieldOfView
 
setNearPlane
 
setOrtho
 
setType
 
- Function List inherited from MOAINode
clearAttrLink
 
clearNodeLink
 
forceUpdate
 
getAttr
 
getAttrLink
 
getNodeState
 
moveAttr
 
scheduleUpdate
 
seekAttr
 
setAttrLink
 
setAttr
 
setNodeLink
 
- Function List inherited from MOAIInstanceEventSource
getListener
 
setListener
 

Additional Inherited Members

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

Function Documentation

getFarPlane

Returns the camera's far plane.


function getFarPlane ( MOAICamera self )

Parameters
MOAICameraself
Returns
number far
getFieldOfView

Returns the camera's horizontal field of view.


function getFieldOfView ( MOAICamera self )

Parameters
MOAICameraself
Returns
number hfov
getFloorMove

Project the given X, Y offset onto the floor (XY plane). Projected X, Y will be rotated to match camera's orientation. This is for implementing a truck along the floor plane relative to the camera's orientation.


function getFloorMove ( MOAICamera self, number x, number y )

Parameters
MOAICameraself
numberx
numbery
Returns
number x, number y
getFocalLength

Returns the camera's focal length given the width of the view plane.


function getFocalLength ( MOAICamera self, number width )

Parameters
MOAICameraself
numberwidth
Returns
number length
getNearPlane

Returns the camera's near plane.


function getNearPlane ( MOAICamera self )

Parameters
MOAICameraself
Returns
number near
getViewVector

Get the camera's normalized view vector (i.e. the Z axis).


function getViewVector ( MOAICamera self )

Parameters
MOAICameraself
Returns
number xN, number yN, number zN
lookAt

Point the camera at a given point in space.


function lookAt ( MOAICamera self, number x, number y, number z )

Parameters
MOAICameraself
numberx
numbery
numberz
Returns
nil
moveFieldOfView

Animate the camera's FOV.


function moveFieldOfView ( MOAICamera self, number fov, number delay )

Parameters
MOAICameraself
numberfov
numberdelay
Returns
nil
seekFieldOfView

Animate the camera's FOV.


function seekFieldOfView ( MOAICamera self, number fov, number delay )

Parameters
MOAICameraself
numberfov
numberdelay
Returns
nil
setFarPlane

Sets the camera's far plane distance.


function setFarPlane ( MOAICamera self [, number far ] )

Parameters
MOAICameraself
numberfar Optional. Default value is 10000.
Returns
nil
setFieldOfView

Sets the camera's horizontal field of view.


function setFieldOfView ( MOAICamera self [, number hfow ] )

Parameters
MOAICameraself
numberhfow Optional. Default value is 60.
Returns
nil
setNearPlane

Sets the camera's near plane distance.


function setNearPlane ( MOAICamera self [, number near ] )

Parameters
MOAICameraself
numbernear Optional. Default value is 1.
Returns
nil
setOrtho

Sets orthographic mode.


function setOrtho ( MOAICamera self [, boolean ortho ] )

Parameters
MOAICameraself
booleanortho Optional. Default value is true.
Returns
nil
setType

Directly set the camera's type to one of CAMERA_TYPE_WINDOW, CAMERA_TYPE_ORTHO, CAMERA_TYPE_3D.


function setType ( MOAICamera self, number type )

Parameters
MOAICameraself
numbertype
Returns
nil