FBColorAndAlpha Class Reference
 
 
 
FBColorAndAlpha Class Reference

#include <fbtypes.h>


Class Description

Color and alpha vector.

Definition at line 489 of file fbtypes.h.

Inheritance diagram for FBColorAndAlpha:
FBVector4< double >

Public Member Functions

  FBColorAndAlpha ()
  Constructor.
  FBColorAndAlpha (double *pValue)
  Constructor from array.
  FBColorAndAlpha (double pRed, double pGreen, double pBlue, double pAlpha=1.0)
  Constructor.
  FBColorAndAlpha (const FBColor &pValue)
  Constructor from FBColor.
  FBColorAndAlpha (const FBColorF &pValue)
  Constructor from FBColorF.
  FBColorAndAlpha (const FBColorAndAlpha &pVector)
  Copy Constructor.
double &  operator[] (int pIndex)
  Overloaded [] operator.
  operator double * () const
  Overloaded cast to array.
const FBColorAndAlpha operator= (const FBColorAndAlpha &pVector)
  Overloaded equal operator.
const FBColorAndAlpha operator= (const FBColor &pVector)
const FBColorAndAlpha operator= (const FBColorF &pVector)
void  operator= (double *pValue)
const FBVector4< double > &  operator= (const FBVector4< double > &pVector)
void  Init ()
  Initialization function.
void  Set (double *pValue)
  Set vector from an array.
bool  operator!= (const FBVector4 &pVector)
  not equal operator.
bool  operator== (const FBVector4 &pVector)
  equal operator.

Public Attributes

double  mValue [4]
  Values.

Constructor & Destructor Documentation

FBColorAndAlpha::FBColorAndAlpha ( )

Constructor.

FBColorAndAlpha::FBColorAndAlpha ( double *  pValue )

Constructor from array.

Parameters:
pValue Array to take values from.
FBColorAndAlpha::FBColorAndAlpha ( double  pRed,
double  pGreen,
double  pBlue,
double  pAlpha = 1.0 
)

Constructor.

Parameters:
pRed Red component.
pGreen Green component.
pBlue Blue component.
pAlpha Alpha component(default=1.0).
FBColorAndAlpha::FBColorAndAlpha ( const FBColor pValue )

Constructor from FBColor.

Parameters:
pValue FBColor to take values from.
FBColorAndAlpha::FBColorAndAlpha ( const FBColorF pValue )

Constructor from FBColorF.

Parameters:
pValue FBColorF to take values from.
FBColorAndAlpha::FBColorAndAlpha ( const FBColorAndAlpha pVector )

Copy Constructor.


Member Function Documentation

double& FBColorAndAlpha::operator[] ( int  pIndex )

Overloaded [] operator.

Parameters:
pIndex Element to access.
Returns:
Element at pIndex.

Reimplemented from FBVector4< double >.

FBColorAndAlpha::operator double * ( ) const

Overloaded cast to array.

Returns:
Array of items of tType.

Reimplemented from FBVector4< double >.

const FBColorAndAlpha& FBColorAndAlpha::operator= ( const FBColorAndAlpha pVector )

Overloaded equal operator.

Parameters:
pVector Vector to copy.
Returns:
this vector as a const.
const FBColorAndAlpha& FBColorAndAlpha::operator= ( const FBColor pVector )
const FBColorAndAlpha& FBColorAndAlpha::operator= ( const FBColorF pVector )
void FBColorAndAlpha::operator= ( double *  pValue )
const FBVector4< double >& FBColorAndAlpha::operator= ( const FBVector4< double > &  pVector )
void FBVector4< double >::Init ( ) [inherited]

Initialization function.

Clear vector.

void FBVector4< double >::Set ( double *  pValue ) [inherited]

Set vector from an array.

Parameters:
pValue Array to copy value from.
bool FBVector4< double >::operator!= ( const FBVector4< double > &  pVector ) [inherited]

not equal operator.

Parameters:
pVector Vector to compare.
Returns:
true if not equal.
bool FBVector4< double >::operator== ( const FBVector4< double > &  pVector ) [inherited]

equal operator.

Parameters:
pVector Vector to compare.
Returns:
true if equal.

Member Data Documentation

double FBVector4< double >::mValue[4] [inherited]

Values.

Definition at line 226 of file fbtypes.h.


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