MOAICameraFitter2D Class Reference

Inheritance diagram for MOAICameraFitter2D:

Function List
	clearAnchors
	clearFitMode
	getFitDistance
	getFitLoc
	getFitMode
	getFitScale
	getTargetLoc
	getTargetScale
	insertAnchor
	removeAnchor
	setBounds
	setCamera
	setDamper
	setFitLoc
	setFitMode
	setFitScale
	setMin
	setViewport
	snapToTarget
	startTrackingNode
	stopTrackingNode
Function List inherited from MOAIAction
	addChild
	attach
	clear
	defer
	detach
	getChildren
	hasChildren
	isActive
	isBusy
	isDone
	isPaused
	pause
	setAutoStop
	start
	stop
	throttle
	update
Function List inherited from MOAIInstanceEventSource
	getListener
	setListener
Function List inherited from MOAINode
	clearAttrLink
	clearNodeLink
	forceUpdate
	getAttr
	getAttrLink
	getNodeState
	moveAttr
	scheduleUpdate
	seekAttr
	setAttrLink
	setAttr
	setNodeLink

Detailed Description

Constants MOAICameraFitter2D.FITTING_MODE_SEEK_LOC MOAICameraFitter2D.FITTING_MODE_SEEK_SCALE MOAICameraFitter2D.FITTING_MODE_APPLY_ANCHORS MOAICameraFitter2D.FITTING_MODE_APPLY_BOUNDS MOAICameraFitter2D.FITTING_MODE_TRACK_NODE MOAICameraFitter2D.FITTING_MODE_DEFAULT MOAICameraFitter2D.FITTING_MODE_MASK

Function Documentation

clearAnchors

Remove all camera anchors from the fitter.

---

function clearAnchors ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

nil

clearFitMode

Clears bits in the fitting mask.

---

function clearFitMode ( MOAICameraFitter2D self [, number mask ] )

Parameters

MOAICameraFitter2D	self
number	mask 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

MOAICameraFitter2D

self

Returns

number distance

getFitLoc

Get the fitter location.

---

function getFitLoc ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

number x, number y

getFitMode

Gets bits in the fitting mask.

---

function getFitMode ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

number mask

getFitScale

Returns the fit scale.

---

function getFitScale ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

number scale

getTargetLoc

Get the target location.

---

function getTargetLoc ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

number x, number y

getTargetScale

Returns the target scale.

---

function getTargetScale ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

number scale

insertAnchor

Add an anchor to the fitter.

---

function insertAnchor ( MOAICameraFitter2D self, MOAICameraAnchor2D anchor )

Parameters

MOAICameraFitter2D	self
MOAICameraAnchor2D	anchor

Returns

nil

removeAnchor

Remove an anchor from the fitter.

---

function removeAnchor ( MOAICameraFitter2D self, MOAICameraAnchor2D anchor )

Parameters

MOAICameraFitter2D	self
MOAICameraAnchor2D	anchor

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

MOAICameraFitter2D	self
number	xMin
number	yMin
number	xMax
number	yMax

Returns

nil

Note

---

function setBounds ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

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

MOAICameraFitter2D	self
MOAITransform	camera 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

MOAICameraFitter2D	self
number	damper Optional. Default value is 0.

Returns

nil

setFitLoc

Set the fitter's location.

---

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

Parameters

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

Returns

nil

setFitMode

Sets bits in the fitting mask.

---

function setFitMode ( MOAICameraFitter2D self [, number mask ] )

Parameters

MOAICameraFitter2D	self
number	mask Optional. Default value is FITTING_MODE_DEFAULT

Returns

nil

setFitScale

Set the fitter's scale.

---

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

Parameters

MOAICameraFitter2D	self
number	scale Optional. Default value is 1.
boolean	snap 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

MOAICameraFitter2D	self
number	min Optional. Default value is 0.

Returns

nil

setViewport

Set the viewport to be used for fitting.

---

function setViewport ( MOAICameraFitter2D self [, MOAIViewport viewport ] )

Parameters

MOAICameraFitter2D	self
MOAIViewport	viewport Optional. Default value is nil.

Returns

nil

snapToTarget

Snap the camera to the target fitting.

---

function snapToTarget ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

nil

Note

Snap the fitter's camera transform to the target.

---

function snapToTarget ( MOAICameraFitter2D self, MOAITransform transform )

Parameters

MOAICameraFitter2D	self
MOAITransform	transform

Returns

nil

Note

Snap a passed in transform to the target.

startTrackingNode

Track a MOAITransform's position by setting the fit location. Works best with FITTING_MODE_APPLY_BOUNDS.

---

function startTrackingNode ( MOAICameraFitter2D self, MOAITransform node )

Parameters

MOAICameraFitter2D	self
MOAITransform	node

Returns

nil

stopTrackingNode

Stop tracking the node if one was tracked.

---

function stopTrackingNode ( MOAICameraFitter2D self )

Parameters

MOAICameraFitter2D

self

Returns

nil