MOAIColor Class Reference

Inheritance diagram for MOAIColor:

Function List
	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

Attributes Description MOAIColor.ATTR_R_COL The R (red) channel MOAIColor.ATTR_G_COL The G (green) channel MOAIColor.ATTR_B_COL The B (blue) channel MOAIColor.ATTR_A_COL The A (alpha) channel MOAIColor.INHERIT_COLOR MOAIColor.COLOR_TRAIT

Function Documentation

getColor

Return the color.

---

function getColor ( MOAIProp self )

Parameters

MOAIProp

self

Returns

number rDelta, number gDelta, number bDelta, number aDelta

moveColor

Animate the color by applying a delta. Creates and returns a MOAIEaseDriver initialized to apply the delta.

---

function moveColor ( MOAIColor self, number rDelta, number gDelta, number bDelta, number aDelta, number length [, number mode ] )

Parameters

MOAIColor	self
number	rDelta Delta to be added to r.
number	gDelta Delta to be added to g.
number	bDelta Delta to be added to b.
number	aDelta Delta to be added to a.
number	length Length of animation in seconds.
number	mode Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.

Returns

MOAIEaseDriver easeDriver

seekColor

Animate the color by applying a delta. Delta is computed given a target value. Creates and returns a MOAIEaseDriver initialized to apply the delta.

---

function seekColor ( MOAIColor self, number rGoal, number gGoal, number bGoal, number aGoal, number length [, number mode ] )

Parameters

MOAIColor	self
number	rGoal Desired resulting value for r.
number	gGoal Desired resulting value for g.
number	bGoal Desired resulting value for b.
number	aGoal Desired resulting value for a.
number	length Length of animation in seconds.
number	mode Optional. The ease mode. One of MOAIEaseType.EASE_IN, MOAIEaseType.EASE_OUT, MOAIEaseType.FLAT MOAIEaseType.LINEAR, MOAIEaseType.SMOOTH, MOAIEaseType.SOFT_EASE_IN, MOAIEaseType.SOFT_EASE_OUT, MOAIEaseType.SOFT_SMOOTH. Defaults to MOAIEaseType.SMOOTH.

Returns

MOAIEaseDriver easeDriver

setColor

Initialize the color.

---

function setColor ( MOAIColor self, number r, number g, number b [, number a ] )

Parameters

MOAIColor	self
number	r Default value is 0.
number	g Default value is 0.
number	b Default value is 0.
number	a Optional. Default value is 1.

Returns

nil

setParent

This method has been deprecated. Use MOAINode setAttrLink instead.

---

function setParent ( MOAIColor self [, MOAINode parent ] )

Parameters

MOAIColor	self
MOAINode	parent Optional. Default value is nil.

Returns

nil