KFbxColor Class Reference

#include <kfbxcolor.h>

List of all members.

---

Detailed Description

Simple class to hold RGBA values.

Definition at line 49 of file kfbxcolor.h.

double	mRed
	name Public Members
double	mGreen
	Valid range is from 0.0 to 1.0.
double	mBlue
	Valid range is from 0.0 to 1.0.
double	mAlpha
	Valid range is from 0.0 to 1.0.
Operators
KFbxColor &	operator= (const KFbxColor &pColor)
	Assignment operator.
bool	operator== (const KFbxColor &pColor)
	Equality operator.
bool	operator!= (const KFbxColor &pColor)
	Inequality operator.
Public Member Functions
	KFbxColor ()
	Constructor.
	KFbxColor (double pRed, double pGreen, double pBlue, double pAlpha=1.0)
	Constructor.
	~KFbxColor ()
	Destructor.
void	Set (double pRed, double pGreen, double pBlue, double pAlpha=1.0)
	Re-initialize the color object with their new values.
bool	IsValid ()
	Indicate if all the members in the color objects are within their valid range.

---

Constructor & Destructor Documentation

KFbxColor

(

)

Constructor.

KFbxColor	(	double	pRed,
		double	pGreen,
		double	pBlue,
		double	pAlpha = 1.0
	)

Constructor.

Parameters:

	pRed	The Red component value.
	pGreen	The Green component value.
	pBlue	The Blue component value.
	pAlpha	The alpha value of the color.

~KFbxColor

(

)

Destructor.

---

Member Function Documentation

void Set	(	double	pRed,
		double	pGreen,
		double	pBlue,
		double	pAlpha = 1.0
	)

Re-initialize the color object with their new values.

Parameters:

	pRed	The Red component value.
	pGreen	The Green component value.
	pBlue	The Blue component value.
	pAlpha	The alpha value of the color.

bool IsValid

(

)

Indicate if all the members in the color objects are within their valid range.

Returns:

true if all the members are within their valid range.

KFbxColor& operator=

(

const KFbxColor &

pColor

)

Assignment operator.

Parameters:

pColor

KFbxColor to be copied.

bool operator==

(

const KFbxColor &

pColor

)

Equality operator.

Parameters:

pColor

KFbxColor compared with this one.

Returns:

True if equal, false if unequal.

bool operator!=

(

const KFbxColor &

pColor

)

Inequality operator.

Parameters:

pColor

KFbxColor compared with this one.

Returns:

True if unequal, false if equal.

---

Member Data Documentation

double mRed

name Public Members

Valid range is from 0.0 to 1.0.

Definition at line 109 of file kfbxcolor.h.

double mGreen

Valid range is from 0.0 to 1.0.

Definition at line 112 of file kfbxcolor.h.

double mBlue

Valid range is from 0.0 to 1.0.

Definition at line 115 of file kfbxcolor.h.

double mAlpha

Valid range is from 0.0 to 1.0.

Definition at line 118 of file kfbxcolor.h.