Public Member Functions

KFbxColor Class Reference

This reference page is linked to from the following overview topics: List of Python FBX classes.


Search for all occurrences

Detailed Description

Class to represent colors in RGBA format using doubles.

Examples:

ExportScene03/main.cxx, ExportScene04/main.cxx, ImportScene/DisplayCamera.cxx, ImportScene/DisplayCommon.cxx, ImportScene/DisplayGenericInfo.cxx, ImportScene/DisplayLight.cxx, ImportScene/DisplayMarker.cxx, ImportScene/DisplayMaterial.cxx, ImportScene/DisplayUserProperties.cxx, Layers/main.cxx, Transformations/DisplayCommon.cxx, UserProperties/main.cxx, ViewScene/DrawScene.cxx, ViewScene/GlFunctions.cxx, ViewScene/GlFunctions.h, ViewScene/Texture.cxx, and ViewScene/Texture.h.

Definition at line 48 of file kfbxcolor.h.

#include <kfbxcolor.h>

List of all members.

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 () const
  Indicate if all the members in the color objects are within their valid range.
double &  operator[] (int pIndex)
  Accessors.
const double &  operator[] (int pIndex) const
  Accessors.

Operators

KFbxColor operator= (const KFbxColor &pColor)
  Assignment operator.
bool  operator== (const KFbxColor &pColor) const
  Equality operator.
bool  operator!= (const KFbxColor &pColor) const
  Inequality operator.

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.

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.
Examples:
ImportScene/DisplayMaterial.cxx.
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.
KFbxColor& operator= ( const KFbxColor pColor )

Assignment operator.

Parameters:
pColor KFbxColor to be copied.
bool operator== ( const KFbxColor pColor ) const

Equality operator.

Parameters:
pColor KFbxColor compared with this one.
Returns:
true if equal, false if unequal.
bool operator!= ( const KFbxColor pColor ) const

Inequality operator.

Parameters:
pColor KFbxColor compared with this one.
Returns:
true if unequal, false if equal.

Member Data Documentation

double mRed
double mGreen
double mBlue
double mAlpha

Valid range is from 0.0 to 1.0.

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

Definition at line 131 of file kfbxcolor.h.


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

KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor
KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor KFbxColor