Moai SDK  1.5 revision 1 (MoaiEdition)
MOAICamera Class Reference
Inheritance diagram for MOAICamera:
MOAITransform MOAITransformBase MOAINode MOAIInstanceEventSource MOAIEventSource

List of all members.

Function List

  getFarPlane
  getFieldOfView
  getFocalLength
  getNearPlane
  setFarPlane
  setFieldOfView
  setNearPlane
  setOrtho

Function Documentation

Returns the camera's far plane.


function getFarPlane ( MOAICamera self )
Parameters:
self ( MOAICamera )
Returns:
far ( number )

Returns the camera's horizontal field of view.


function getFieldOfView ( MOAICamera self )
Parameters:
self ( MOAICamera )
Returns:
hfov ( number )

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


function getFocalLength ( MOAICamera self, number width )
Parameters:
self ( MOAICamera )
width ( number )
Returns:
length ( number )

Returns the camera's near plane.


function getNearPlane ( MOAICamera self )
Parameters:
self ( MOAICamera )
Returns:
near ( number )

Sets the camera's far plane distance.


function setFarPlane ( MOAICamera self [, number far ] )
Parameters:
self ( MOAICamera )
far ( number ) Optional. Default value is 10000.
Returns:
nil

Sets the camera's horizontal field of view.


function setFieldOfView ( MOAICamera self [, number hfow ] )
Parameters:
self ( MOAICamera )
hfow ( number ) Optional. Default value is 60.
Returns:
nil

Sets the camera's near plane distance.


function setNearPlane ( MOAICamera self [, number near ] )
Parameters:
self ( MOAICamera )
near ( number ) Optional. Default value is 1.
Returns:
nil

Sets orthographic mode.


function setOrtho ( MOAICamera self [, boolean ortho ] )
Parameters:
self ( MOAICamera )
ortho ( boolean ) Optional. Default value is true.
Returns:
nil