MOAICameraFitter2D Class Reference

Inheritance diagram for MOAICameraFitter2D:

List of all members.

Function List
	clearAnchors
	clearFitMode
	getFitDistance
	getFitLoc
	getFitMode
	getFitScale
	getTargetLoc
	getTargetScale
	insertAnchor
	removeAnchor
	setBounds
	setCamera
	setDamper
	setFitLoc
	setFitMode
	setFitScale
	setMin
	setViewport
	snapToTarget

---

Function Documentation

clearAnchors

Remove all camera anchors from the fitter.

---

function clearAnchors ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

nil

clearFitMode

Clears bits in the fitting mask.

---

function clearFitMode ( MOAICameraFitter2D self [, number mask ] )

Parameters:

self	( MOAICameraFitter2D )
mask	( number ) Optional. Default value is FITTING_MODE_MASK

Returns:

nil

getFitDistance

Returns the distance between the camera's current x, y, scale and the target x, y, scale. As the camera approaches its target, the distance approaches 0. Check the value returned by this function against a small epsilon value.

---

function getFitDistance ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

distance ( number )

getFitLoc

Get the fitter location.

---

function getFitLoc ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

x ( number ), y ( number )

getFitMode

Gets bits in the fitting mask.

---

function getFitMode ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

mask ( number )

getFitScale

Returns the fit scale.

---

function getFitScale ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

scale ( number )

getTargetLoc

Get the target location.

---

function getTargetLoc ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

x ( number ), y ( number )

getTargetScale

Returns the target scale.

---

function getTargetScale ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

scale ( number )

insertAnchor

Add an anchor to the fitter.

---

function insertAnchor ( MOAICameraFitter2D self, MOAICameraAnchor2D anchor )

Parameters:

self	( MOAICameraFitter2D )
anchor	( MOAICameraAnchor2D )

Returns:

nil

removeAnchor

Remove an anchor from the fitter.

---

function removeAnchor ( MOAICameraFitter2D self, MOAICameraAnchor2D anchor )

Parameters:

self	( MOAICameraFitter2D )
anchor	( MOAICameraAnchor2D )

Returns:

nil

setBounds

Sets or clears the world bounds of the fitter. The camera will not move outside of the fitter's bounds.

---

function setBounds ( MOAICameraFitter2D self, number xMin, number yMin, number xMax, number yMax )

Parameters:

self	( MOAICameraFitter2D )
xMin	( number )
yMin	( number )
xMax	( number )
yMax	( number )

Returns:

nil

Note:

---

function setBounds ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

nil

Note:

setCamera

Set a MOAITransform for the fitter to use as a camera. The fitter will dynamically change the location and scale of the camera to keep all of the anchors on the screen.

---

function setCamera ( MOAICameraFitter2D self [, MOAITransform camera ] )

Parameters:

self	( MOAICameraFitter2D )
camera	( MOAITransform ) Optional. Default value is nil.

Returns:

nil

setDamper

Sets the fitter's damper coefficient. This is a scalar applied to the difference between the camera transform's location and the fitter's target location every frame. The smaller the coefficient, the tighter the fit will be. A value of '0' will not dampen at all; a value of '1' will never move the camera.

---

function setDamper ( MOAICameraFitter2D self [, number damper ] )

Parameters:

self	( MOAICameraFitter2D )
damper	( number ) Optional. Default value is 0.

Returns:

nil

setFitLoc

Set the fitter's location.

---

function setFitLoc ( MOAICameraFitter2D self [, number x, number y, boolean snap ] )

Parameters:

self	( MOAICameraFitter2D )
x	( number ) Optional. Default value is 0.
y	( number ) Optional. Default value is 0.
snap	( boolean ) Optional. Default value is false.

Returns:

nil

setFitMode

Sets bits in the fitting mask.

---

function setFitMode ( MOAICameraFitter2D self [, number mask ] )

Parameters:

self	( MOAICameraFitter2D )
mask	( number ) Optional. Default value is FITTING_MODE_DEFAULT

Returns:

nil

setFitScale

Set the fitter's scale.

---

function setFitScale ( MOAICameraFitter2D self [, number scale, boolean snap ] )

Parameters:

self	( MOAICameraFitter2D )
scale	( number ) Optional. Default value is 1.
snap	( boolean ) Optional. Default value is false.

Returns:

nil

setMin

Set the minimum number of world units to be displayed by the camera along either axis.

---

function setMin ( MOAICameraFitter2D self [, number min ] )

Parameters:

self	( MOAICameraFitter2D )
min	( number ) Optional. Default value is 0.

Returns:

nil

setViewport

Set the viewport to be used for fitting.

---

function setViewport ( MOAICameraFitter2D self [, MOAIViewport viewport ] )

Parameters:

self	( MOAICameraFitter2D )
viewport	( MOAIViewport ) Optional. Default value is nil.

Returns:

nil

snapToTarget

Snap the camera to the target fitting.

---

function snapToTarget ( MOAICameraFitter2D self )

Parameters:

self	( MOAICameraFitter2D )

Returns:

nil

Note:

Snap the fitter's camera transform to the target.

---

function snapToTarget ( MOAICameraFitter2D self, MOAITransform transform )

Parameters:

self	( MOAICameraFitter2D )
transform	( MOAITransform )

Returns:

nil

Note:

Snap a passed in transform to the target.