Contents Functions Classes Topics User Forum CVS

G3D::Color3 Class Reference

#include <Color3.h>

List of all members.

Public Member Functions

 Color3 ()
 Color3 (class BinaryInput &bi)
 Color3 (float r, float g, float b)
 Color3 (const class Vector3 &v)
 Color3 (const float value[3])
 Color3 (const Color3 &other)
 Color3 (const class Color3uint8 &other)
void serialize (class BinaryOutput &bo) const
void deserialize (class BinaryInput &bi)
const float & operator[] (int i) const
float & operator[] (int i)
Color3operator= (const Color3 &rkVector)
bool operator== (const Color3 &rkVector) const
bool operator!= (const Color3 &rkVector) const
unsigned int hashCode () const
Color3 operator+ (const Color3 &rkVector) const
Color3 operator- (const Color3 &rkVector) const
Color3 operator * (float fScalar) const
Color3 operator * (const Color3 &rkVector) const
Color3 operator/ (float fScalar) const
Color3 operator- () const
Color3operator+= (const Color3 &rkVector)
Color3operator-= (const Color3 &rkVector)
Color3operator *= (const Color3 &rkVector)
Color3operator *= (float fScalar)
Color3operator/= (float fScalar)
bool fuzzyEq (const Color3 &other) const
bool fuzzyNe (const Color3 &other) const
 operator float * ()
 operator const float * () const
float length () const
Color3 direction () const
float squaredLength () const
float dot (const Color3 &rkVector) const
float unitize (float fTolerance=1e-06)
Color3 cross (const Color3 &rkVector) const
Color3 unitCross (const Color3 &rkVector) const
Color3 max (const Color3 &other) const
Color3 min (const Color3 &other) const
Color3 lerp (const Color3 &other, float a) const
double sum () const
double average () const
std::string toString () const

Static Public Member Functions

static Color3 fromARGB (uint32)
static const Color3wheelRandom ()
static Color3 fromHSV (const Vector3 &_hsv)
static Vector3 toHSV (const Color3 &_rgb)
static Color3 jetColorMap (const float &val)
static Color3 random ()
static const Color3red ()
static const Color3green ()
static const Color3blue ()
static const Color3purple ()
static const Color3cyan ()
static const Color3yellow ()
static const Color3brown ()
static const Color3orange ()
static const Color3black ()
static const Color3gray ()
static const Color3white ()

Public Attributes

float r
float g
float b

Static Public Attributes

static const Color3 RED
static const Color3 GREEN
static const Color3 BLUE
static const Color3 PURPLE
static const Color3 CYAN
static const Color3 YELLOW
static const Color3 BROWN
static const Color3 ORANGE
static const Color3 BLACK
static const Color3 GRAY
static const Color3 WHITE


Detailed Description

Do not subclass-- this implementation makes assumptions about the memory layout.


Constructor & Destructor Documentation

G3D::Color3::Color3  ) 
 

Does not initialize fields.

G3D::Color3::Color3 class BinaryInput bi  ) 
 

G3D::Color3::Color3 float  r,
float  g,
float  b
 

G3D::Color3::Color3 const class Vector3 v  ) 
 

G3D::Color3::Color3 const float  value[3]  ) 
 

G3D::Color3::Color3 const Color3 other  ) 
 

Initialize from another color.

G3D::Color3::Color3 const class Color3uint8 other  ) 
 


Member Function Documentation

double G3D::Color3::average  )  const [inline]
 

static const Color3& G3D::Color3::black  )  [static]
 

static const Color3& G3D::Color3::blue  )  [static]
 

static const Color3& G3D::Color3::brown  )  [static]
 

Color3 G3D::Color3::cross const Color3 rkVector  )  const
 

static const Color3& G3D::Color3::cyan  )  [static]
 

void G3D::Color3::deserialize class BinaryInput bi  ) 
 

Color3 G3D::Color3::direction  )  const
 

float G3D::Color3::dot const Color3 rkVector  )  const
 

static Color3 G3D::Color3::fromARGB uint32   )  [static]
 

Initialize from an HTML-style color (e.g. 0xFF0000 == RED)

static Color3 G3D::Color3::fromHSV const Vector3 _hsv  )  [static]
 

Converts from HSV to RGB , note: toHSV(fromHSV(_hsv)) may not be _hsv, if it is at a grey point or black point. The components of _hsv should lie in the unit interval.

Referenced Code:
Alvy Ray Smith SIGGRAPH 1978 "Color Gamut Transform Pairs"

bool G3D::Color3::fuzzyEq const Color3 other  )  const
 

bool G3D::Color3::fuzzyNe const Color3 other  )  const
 

static const Color3& G3D::Color3::gray  )  [static]
 

static const Color3& G3D::Color3::green  )  [static]
 

unsigned int G3D::Color3::hashCode  )  const
 

static Color3 G3D::Color3::jetColorMap const float &  val  )  [static]
 

Duplicates the matlab jet colormap maps [0,1] --> (r,g,b) where blue is close to 0 and red is close to 1.

float G3D::Color3::length  )  const
 

Color3 G3D::Color3::lerp const Color3 other,
float  a
const [inline]
 

Color3 G3D::Color3::max const Color3 other  )  const [inline]
 

Color3 G3D::Color3::min const Color3 other  )  const [inline]
 

Color3 G3D::Color3::operator * const Color3 rkVector  )  const
 

Color3 G3D::Color3::operator * float  fScalar  )  const
 

Color3& G3D::Color3::operator *= float  fScalar  ) 
 

Color3& G3D::Color3::operator *= const Color3 rkVector  ) 
 

G3D::Color3::operator const float *  )  const [inline]
 

G3D::Color3::operator float *  )  [inline]
 

bool G3D::Color3::operator!= const Color3 rkVector  )  const
 

Color3 G3D::Color3::operator+ const Color3 rkVector  )  const
 

Color3& G3D::Color3::operator+= const Color3 rkVector  ) 
 

Color3 G3D::Color3::operator-  )  const
 

Color3 G3D::Color3::operator- const Color3 rkVector  )  const
 

Color3& G3D::Color3::operator-= const Color3 rkVector  ) 
 

Color3 G3D::Color3::operator/ float  fScalar  )  const
 

Color3& G3D::Color3::operator/= float  fScalar  ) 
 

Color3& G3D::Color3::operator= const Color3 rkVector  ) 
 

bool G3D::Color3::operator== const Color3 rkVector  )  const
 

float& G3D::Color3::operator[] int  i  ) 
 

const float& G3D::Color3::operator[] int  i  )  const
 

static const Color3& G3D::Color3::orange  )  [static]
 

static const Color3& G3D::Color3::purple  )  [static]
 

static Color3 G3D::Color3::random  )  [static]
 

Random unit vector

static const Color3& G3D::Color3::red  )  [static]
 

void G3D::Color3::serialize class BinaryOutput bo  )  const
 

float G3D::Color3::squaredLength  )  const
 

double G3D::Color3::sum  )  const [inline]
 

static Vector3 G3D::Color3::toHSV const Color3 _rgb  )  [static]
 

std::string G3D::Color3::toString  )  const
 

Color3 G3D::Color3::unitCross const Color3 rkVector  )  const
 

float G3D::Color3::unitize float  fTolerance = 1e-06  ) 
 

static const Color3& G3D::Color3::wheelRandom  )  [static]
 

Returns one of the color wheel colors (e.g. RED, GREEN, CYAN). Does not include white, black, or gray.

static const Color3& G3D::Color3::white  )  [static]
 

static const Color3& G3D::Color3::yellow  )  [static]
 


Member Data Documentation

float G3D::Color3::b
 

const Color3 G3D::Color3::BLACK [static]
 

Deprecated:
Use Color3::black()

const Color3 G3D::Color3::BLUE [static]
 

Deprecated:
Use Color3::blue()

const Color3 G3D::Color3::BROWN [static]
 

Deprecated:
Use Color3::brown()

const Color3 G3D::Color3::CYAN [static]
 

Deprecated:
Use Color3::cyan()

float G3D::Color3::g
 

const Color3 G3D::Color3::GRAY [static]
 

Deprecated:
Use Color3::gray()

const Color3 G3D::Color3::GREEN [static]
 

Deprecated:
Use Color3::green()

const Color3 G3D::Color3::ORANGE [static]
 

Deprecated:
Use Color3::orange()

const Color3 G3D::Color3::PURPLE [static]
 

Deprecated:
Use Color3::purple()

float G3D::Color3::r
 

Channel value.

const Color3 G3D::Color3::RED [static]
 

Deprecated:
Use Color3::red()

const Color3 G3D::Color3::WHITE [static]
 

Deprecated:
Use Color3::white()

const Color3 G3D::Color3::YELLOW [static]
 

Deprecated:
Use Color3::yellow()


The documentation for this class was generated from the following file:
Generated on Mon Jul 17 11:50:46 2006 for G3D by doxygen 1.4.5
Hosted by SourceForge.net Logo