MOAISpriteDeck2D Class Reference

Inheritance diagram for MOAISpriteDeck2D:

Function List
	getQuad
	getRect
	getUVQuad
	getUVRect
	reserveQuads
	reserveSprites
	reserveSpriteLists
	reserveUVQuads
	setQuad
	setRect
	setSprite
	setSpriteList
	setUVQuad
	setUVRect
	transform
	transformUV

Additional Inherited Members
Function List inherited from MOAIDeck
	getBounds

Function Documentation

getQuad

Get model space quad given a deck index. Vertex order is clockwiese from upper left.

---

function getQuad ( MOAISpriteDeck2D self, number idx )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.

Returns

number x0, number y0, number x1, number y1, number x2, number y2, number x3, number y3

getRect

Set model space quad given a valid deck index and a rect.

---

function getRect ( MOAISpriteDeck2D self, number idx )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.

Returns

number xMin, number yMin, number xMax, number yMax

getUVQuad

Get UV model space quad given a valid deck index. Vertex order is clockwise from upper left.

---

function getUVQuad ( MOAISpriteDeck2D self, number idx )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.

Returns

number u0, number v0, number u1, number v1, number u2, number v2, number u3, number v3

getUVRect

Get UV model space quad given a valid deck index.

---

function getUVRect ( MOAISpriteDeck2D self, number idx )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.

Returns

number xMin, number yMin, number xMax, number yMax

reserveQuads

Reserve quads.

---

function reserveQuads ( MOAISpriteDeck2D self, number nQuads )

Parameters

MOAISpriteDeck2D	self
number	nQuads

Returns

nil

reserveSpriteLists

Reserve quad lists.

---

function reserveSpriteLists ( MOAISpriteDeck2D self, number nLists )

Parameters

MOAISpriteDeck2D	self
number	nLists

Returns

nil

reserveSprites

Reserve sprites.

---

function reserveSprites ( MOAISpriteDeck2D self, number nPairs )

Parameters

MOAISpriteDeck2D	self
number	nPairs

Returns

nil

reserveUVQuads

Reserve UV quads.

---

function reserveUVQuads ( MOAISpriteDeck2D self, number nUVQuads )

Parameters

MOAISpriteDeck2D	self
number	nUVQuads

Returns

nil

setQuad

Set model space quad given a valid deck index. Vertex order is clockwise from upper left (xMin, yMax)

---

function setQuad ( MOAISpriteDeck2D self, number idx, number x0, number y0, number x1, number y1, number x2, number y2, number x3, number y3 )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.
number	x0
number	y0
number	x1
number	y1
number	x2
number	y2
number	x3
number	y3

Returns

nil

setRect

Set model space quad given a valid deck index and a rect.

---

function setRect ( MOAISpriteDeck2D self, number idx, number xMin, number yMin, number xMax, number yMax )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.
number	xMin
number	yMin
number	xMax
number	yMax

Returns

nil

setSprite

Associates a quad with its UV coordinates.

---

function setSprite ( MOAISpriteDeck2D self, number idx, number uvQuadID, number quadID [, number materialID ] )

Parameters

MOAISpriteDeck2D	self
number	idx
number	uvQuadID
number	quadID
number	materialID Optional.

Returns

nil

setSpriteList

Initializes quad pair list at index. A list starts at the index of a pair and then continues sequentially for n pairs after. So a list with base 3 and a run of 4 would display pair 3, 4, 5, and 6.

---

function setSpriteList ( MOAISpriteDeck2D self, number idx, number basePairID, number totalPairs )

Parameters

MOAISpriteDeck2D	self
number	idx
number	basePairID The base pair of the list.
number	totalPairs The run of the list - total pairs to display (including base).

Returns

nil

setUVQuad

Set UV space quad given a valid deck index. Vertex order is clockwise from upper left (xMin, yMax)

---

function setUVQuad ( MOAISpriteDeck2D self, number idx, number x0, number y0, number x1, number y1, number x2, number y2, number x3, number y3 )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.
number	x0
number	y0
number	x1
number	y1
number	x2
number	y2
number	x3
number	y3

Returns

nil

setUVRect

Set UV space quad given a valid deck index and a rect.

---

function setUVRect ( MOAISpriteDeck2D self, number idx, number xMin, number yMin, number xMax, number yMax )

Parameters

MOAISpriteDeck2D	self
number	idx Index of the quad.
number	xMin
number	yMin
number	xMax
number	yMax

Returns

nil

transform

Apply the given MOAITransform to all the vertices in the deck.

---

function transform ( MOAISpriteDeck2D self, MOAITransform transform )

Parameters

MOAISpriteDeck2D	self
MOAITransform	transform

Returns

nil

transformUV

Apply the given MOAITransform to all the uv coordinates in the deck.

---

function transformUV ( MOAISpriteDeck2D self, MOAITransform transform )

Parameters

MOAISpriteDeck2D	self
MOAITransform	transform

Returns

nil