MOAIPartitionViewLayer Class Reference

Inherits MOAIPartitionHolder, and MOAIViewLayer.

Function List
	getPropViewList
	getSortMode
	getSortScale
	setPartitionCull2D
	setSortMode
	setSortScale

Detailed Description

Constants MOAIPartitionViewLayer.SORT_NONE MOAIPartitionViewLayer.SORT_ISO MOAIPartitionViewLayer.SORT_PRIORITY_ASCENDING MOAIPartitionViewLayer.SORT_PRIORITY_DESCENDING MOAIPartitionViewLayer.SORT_X_ASCENDING MOAIPartitionViewLayer.SORT_X_DESCENDING MOAIPartitionViewLayer.SORT_Y_ASCENDING MOAIPartitionViewLayer.SORT_Y_DESCENDING MOAIPartitionViewLayer.SORT_Z_ASCENDING MOAIPartitionViewLayer.SORT_Z_DESCENDING MOAIPartitionViewLayer.SORT_VECTOR_ASCENDING MOAIPartitionViewLayer.SORT_VECTOR_DESCENDING

Function Documentation

getPropViewList

Return a list of props gathered and sorted by layer.

---

function getPropViewList ( MOAIPartitionViewLayer self [, number sortMode, boolean sortInViewSpace, number xSortScale, number ySortScale, number zSortScale, number pSortScale ] )

Parameters

MOAIPartitionViewLayer	self
number	sortMode Optional. Default is layer's current value.
boolean	sortInViewSpace Optional. Default is layer's current value.
number	xSortScale Optional. Default is layer's current value.
number	ySortScale Optional. Default is layer's current value.
number	zSortScale Optional. Default is layer's current value.
number	pSortScale Optional. Priority sort scale. Default is layer's current value.

Returns

...

getSortMode

Get the sort mode for rendering.

---

function getSortMode ( MOAIPartitionViewLayer self )

Parameters

MOAIPartitionViewLayer

self

Returns

number sortMode

getSortScale

Return the scalar applied to axis sorts.

---

function getSortScale ( MOAIPartitionViewLayer self )

Parameters

MOAIPartitionViewLayer

self

Returns

number x, number y, number priority

setPartitionCull2D

Enables 2D partition cull (projection of frustum AABB will be used instead of AABB or frustum).

---

function setPartitionCull2D ( MOAIPartitionViewLayer self, boolean partitionCull2D )

Parameters

MOAIPartitionViewLayer	self
boolean	partitionCull2D Default value is false.

Returns

nil

setSortMode

Set the sort mode for rendering.

---

function setSortMode ( MOAIPartitionViewLayer self, number sortMode, boolean sortInViewSpace )

Parameters

MOAIPartitionViewLayer	self
number	sortMode One of MOAIPartitionViewLayer.SORT_NONE, MOAIPartitionViewLayer.SORT_PRIORITY_ASCENDING, MOAIPartitionViewLayer.SORT_PRIORITY_DESCENDING, MOAIPartitionViewLayer.SORT_X_ASCENDING, MOAIPartitionViewLayer.SORT_X_DESCENDING, MOAIPartitionViewLayer.SORT_Y_ASCENDING, MOAIPartitionViewLayer.SORT_Y_DESCENDING, MOAIPartitionViewLayer.SORT_Z_ASCENDING, MOAIPartitionViewLayer.SORT_Z_DESCENDING
boolean	sortInViewSpace Default value is 'false'.

Returns

nil

setSortScale

Set the scalar applied to axis sorts.

---

function setSortScale ( MOAIPartitionViewLayer self [, number x, number y, number z, number priority ] )

Parameters

MOAIPartitionViewLayer	self
number	x Optional. Default value is 0.
number	y Optional. Default value is 0.
number	z Optional. Default value is 0.
number	priority Optional. Default value is 1.

Returns

nil