FbxColor Class Reference

This reference page is linked to from the following overview topics:

---

#include <fbxpropertytypes.h>

Class Description

Class to represent colors in RGBA format using doubles.

Examples:

Definition at line 60 of file fbxpropertytypes.h.

Public Member Functions
	FbxColor ()
	Constructor. More...
	FbxColor (const double pRed, const double pGreen, const double pBlue, const double pAlpha=1.0)
	Constructor. More...
	FbxColor (const FbxDouble3 &pRGB, const double pAlpha=1.0)
	FbxColor (const FbxDouble4 &pRGBA)
	~FbxColor ()
	Destructor. More...
void	Set (const double pRed, const double pGreen, const double pBlue, const double pAlpha=1.0)
	Re-initialize the color object with their new values. More...
bool	IsValid () const
	Indicate if all the members in the color objects are within their valid range. More...
double &	operator[] (int pIndex)
	Accessors. More...
const double &	operator[] (int pIndex) const
	Accessors. More...

Operators
FbxColor &	operator= (const FbxColor &pColor)
	Assignment operator. More...
FbxColor &	operator= (const FbxDouble3 &pColor)
FbxColor &	operator= (const FbxDouble4 &pColor)
bool	operator== (const FbxColor &pColor) const
	Equality operator. More...
bool	operator!= (const FbxColor &pColor) const
	Inequality operator. More...
double	mRed
	name Public Members More...
double	mGreen
	Valid range is from 0.0 to 1.0. More...
double	mBlue
	Valid range is from 0.0 to 1.0. More...
double	mAlpha
	Valid range is from 0.0 to 1.0. More...

Constructor & Destructor Documentation

FbxColor

(

)

Constructor.

FbxColor	(	const double	pRed,
		const double	pGreen,
		const double	pBlue,
		const 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.

FbxColor	(	const FbxDouble3 &	pRGB,
		const double	pAlpha = 1.0
	)

FbxColor

(

const FbxDouble4 &

pRGBA

)

~FbxColor

(

)

Destructor.

Member Function Documentation

void Set	(	const double	pRed,
		const double	pGreen,
		const double	pBlue,
		const 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.

Examples:

bool IsValid

(

)

const

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.

double& operator[]

(

int

pIndex

)

Accessors.

Parameters

pIndex

The index of the component to access.

Returns

The reference to the indexed component.

Remarks

The pIndex parameter is not checked for values out of bounds.

const double& operator[]

(

int

pIndex

)

const

Accessors.

Parameters

pIndex

The index of the component to access.

Returns

The reference to the indexed component.

Remarks

The pIndex parameter is not checked for values out of bounds.

FbxColor& operator=

(

const FbxColor &

pColor

)

Assignment operator.

Parameters

pColor

FbxColor to be copied.

FbxColor& operator=

(

const FbxDouble3 &

pColor

)

FbxColor& operator=

(

const FbxDouble4 &

pColor

)

bool operator==

(

const FbxColor &

pColor

)

const

Equality operator.

Parameters

pColor

FbxColor compared with this one.

Returns

true if equal, false if unequal.

bool operator!=

(

const FbxColor &

pColor

)

const

Inequality operator.

Parameters

pColor

FbxColor 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.

Examples:

Definition at line 135 of file fbxpropertytypes.h.

double mGreen

Valid range is from 0.0 to 1.0.

Examples:

Definition at line 138 of file fbxpropertytypes.h.

double mBlue

Valid range is from 0.0 to 1.0.

Examples:

Definition at line 141 of file fbxpropertytypes.h.

double mAlpha

Valid range is from 0.0 to 1.0.

Examples:

Definition at line 144 of file fbxpropertytypes.h.

---

The documentation for this class was generated from the following file:

• fbxsdk/core/fbxpropertytypes.h