MOAIGraphicsPropBase Class Reference

Inheritance diagram for MOAIGraphicsPropBase:

Function List
	isVisible
	setBillboard
	setParent
	setScissorRect
	setUVTransform
	setVisible
Function List inherited from MOAIPartitionHull
	getBounds
	getDims
	getPartition
	getPriority
	getWorldBounds
	inside
	setBounds
	setExpandForSort
	setHitGranularity
	setPriority
Function List inherited from MOAITransform
	addLoc
	addPiv
	addRot
	addScl
	getLoc
	getPiv
	getRot
	getScl
	move
	moveLoc
	movePiv
	moveRot
	moveScl
	seek
	seekLoc
	seekPiv
	seekRot
	seekScl
	setLoc
	setPiv
	setRot
	setScl
	setShearByX
	setShearByY
	setShearByZ
Function List inherited from MOAITransformBase
	getWorldDir
	getWorldLoc
	getWorldRot
	getWorldScl
	getWorldXAxis
	getWorldYAxis
	getWorldZAxis
	getWorldXNormal
	getWorldYNormal
	getWorldZNormal
	modelToWorld
	setParent
	worldToModel
Function List inherited from MOAIColor
	getColor
	moveColor
	seekColor
	setColor
	setParent

Additional Inherited Members
Function List inherited from MOAINode
	clearAttrLink
	clearNodeLink
	forceUpdate
	getAttr
	getAttrLink
	getNodeState
	moveAttr
	scheduleUpdate
	seekAttr
	setAttrLink
	setAttr
	setNodeLink
Function List inherited from MOAIInstanceEventSource
	getListener
	setListener

Detailed Description

Constants MOAIGraphicsPropBase.FRAME_FROM_DECK MOAIGraphicsPropBase.FRAME_FROM_PARENT MOAIGraphicsPropBase.FRAME_FROM_SELF MOAIGraphicsPropBase.GL_FUNC_ADD MOAIGraphicsPropBase.GL_FUNC_SUBTRACT MOAIGraphicsPropBase.GL_FUNC_REVERSE_SUBTRACT MOAIGraphicsPropBase.GL_ONE MOAIGraphicsPropBase.GL_ZERO MOAIGraphicsPropBase.GL_DST_ALPHA MOAIGraphicsPropBase.GL_DST_COLOR MOAIGraphicsPropBase.GL_SRC_COLOR MOAIGraphicsPropBase.GL_ONE_MINUS_DST_ALPHA MOAIGraphicsPropBase.GL_ONE_MINUS_DST_COLOR MOAIGraphicsPropBase.GL_ONE_MINUS_SRC_ALPHA MOAIGraphicsPropBase.GL_ONE_MINUS_SRC_COLOR MOAIGraphicsPropBase.GL_SRC_ALPHA MOAIGraphicsPropBase.GL_SRC_ALPHA_SATURATE MOAIGraphicsPropBase.DEPTH_TEST_DISABLE MOAIGraphicsPropBase.DEPTH_TEST_NEVER MOAIGraphicsPropBase.DEPTH_TEST_LESS MOAIGraphicsPropBase.DEPTH_TEST_EQUAL MOAIGraphicsPropBase.DEPTH_TEST_LESS_EQUAL MOAIGraphicsPropBase.DEPTH_TEST_GREATER MOAIGraphicsPropBase.DEPTH_TEST_NOTEQUAL MOAIGraphicsPropBase.DEPTH_TEST_GREATER_EQUAL MOAIGraphicsPropBase.DEPTH_TEST_ALWAYS MOAIGraphicsPropBase.CULL_NONE MOAIGraphicsPropBase.CULL_ALL MOAIGraphicsPropBase.CULL_BACK MOAIGraphicsPropBase.CULL_FRONT

Function Documentation

isVisible

Returns true if the given prop is visible. An optional LOD factor may be passed in to test the prop's LOD settings.

---

function isVisible ( MOAIGraphicsPropBase self )

Parameters

MOAIGraphicsPropBase

self

Returns

boolean isVisible

setBillboard

Sets the prop's billboarding mode. One of BILLBOARD_NORMAL, BILLBOARD_ORTHO, BILLBOARD_COMPASS, BILLBOARD_SCREEN, BILLBOARD_NONE.

---

function setBillboard ( MOAIGraphicsPropBase self, boolean billboard, MOAIGraphicsPropBase self, number mode )

Parameters

MOAIGraphicsPropBase	self
boolean	billboard true == BILLBOARD_NORMAL, false == BILLBOARD_NONE
MOAIGraphicsPropBase	self
number	mode

Returns

nil, nil

setParent

This method has been deprecated. Use MOAINode setAttrLink instead.

---

function setParent ( MOAIGraphicsPropBase self [, MOAINode parent ] )

Parameters

MOAIGraphicsPropBase	self
MOAINode	parent Optional. Default value is nil.

Returns

nil

setScissorRect

Set or clear the prop's scissor rect.

---

function setScissorRect ( MOAIGraphicsPropBase self [, MOAIScissorRect scissorRect ] )

Parameters

MOAIGraphicsPropBase	self
MOAIScissorRect	scissorRect Optional. Default value is nil.

Returns

nil

setUVTransform

Sets or clears the prop's UV transform.

---

function setUVTransform ( MOAIGraphicsPropBase self [, MOAITransformBase transform ] )

Parameters

MOAIGraphicsPropBase	self
MOAITransformBase	transform Optional. Default value is nil.

Returns

nil

setVisible

Sets or clears the prop's visibility.

---

function setVisible ( MOAIGraphicsPropBase self [, boolean visible ] )

Parameters

MOAIGraphicsPropBase	self
boolean	visible Optional. Default value is true.

Returns

nil