FBX C++ API Reference
FbxColor Class Reference

#include <fbxpropertytypes.h>

Class Description

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

FbxColoroperator= (const FbxColor &pColor)
 Assignment operator. More...
 
FbxColoroperator= (const FbxDouble3 &pColor)
 
FbxColoroperator= (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() [1/4]

FbxColor ( )

Constructor.

◆ FbxColor() [2/4]

FbxColor ( const double  pRed,
const double  pGreen,
const double  pBlue,
const double  pAlpha = 1.0 
)

Constructor.

Parameters
pRedThe Red component value.
pGreenThe Green component value.
pBlueThe Blue component value.
pAlphaThe alpha value of the color.

◆ FbxColor() [3/4]

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

◆ FbxColor() [4/4]

FbxColor ( const FbxDouble4 pRGBA)

◆ ~FbxColor()

~FbxColor ( )

Destructor.

Member Function Documentation

◆ Set()

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
pRedThe Red component value.
pGreenThe Green component value.
pBlueThe Blue component value.
pAlphaThe alpha value of the color.
Examples:
ImportScene/DisplayMaterial.cxx.

◆ IsValid()

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.

◆ operator[]() [1/2]

double& operator[] ( int  pIndex)

Accessors.

Parameters
pIndexThe 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.

◆ operator[]() [2/2]

const double& operator[] ( int  pIndex) const

Accessors.

Parameters
pIndexThe 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.

◆ operator=() [1/3]

FbxColor& operator= ( const FbxColor pColor)

Assignment operator.

Parameters
pColorFbxColor to be copied.

◆ operator=() [2/3]

FbxColor& operator= ( const FbxDouble3 pColor)

◆ operator=() [3/3]

FbxColor& operator= ( const FbxDouble4 pColor)

◆ operator==()

bool operator== ( const FbxColor pColor) const

Equality operator.

Parameters
pColorFbxColor compared with this one.
Returns
true if equal, false if unequal.

◆ operator!=()

bool operator!= ( const FbxColor pColor) const

Inequality operator.

Parameters
pColorFbxColor compared with this one.
Returns
true if unequal, false if equal.

Member Data Documentation

◆ mRed

double mRed

name Public Members

Valid range is from 0.0 to 1.0.

Examples:
ImportScene/DisplayCommon.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayUserProperties.cxx, and Transformations/DisplayCommon.cxx.

Definition at line 136 of file fbxpropertytypes.h.

◆ mGreen

◆ mBlue

◆ mAlpha

double mAlpha

Valid range is from 0.0 to 1.0.

Examples:
ImportScene/DisplayGenericInfo.cxx, and ImportScene/DisplayUserProperties.cxx.

Definition at line 145 of file fbxpropertytypes.h.


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