osg::Color3ub Class Reference

Inheritance diagram for osg::Color3ub:

List of all members.

Public Types
typedef UInt8	ValueType
Public Member Functions
*	Color3 (void)
	Color3 (const Color3 &source)
	Color3 (ValueType red, ValueType green, ValueType blue)
*void	clear (void)
void	setValuesRGB (const ValueType red, const ValueType green, const ValueType blue)
void	setValuesHSV (const Real32 h, const Real32 s, const Real32 v)
void	setRandom (void)
void	setRGB (UInt32 rgbPack)
void	setValue (const Char8 *szString)
void	setValue (Char8 *szString)
*UInt32	getRGB (void) const
void	getValuesRGB (ValueType &red, ValueType &green, ValueType &blue) const
ValueType *	getValuesRGB (void)
const ValueType *	getValuesRGB (void) const
void	getValuesHSV (Real32 &h, Real32 &s, Real32 &v) const
ValueType	red (void) const
ValueType	green (void) const
ValueType	blue (void) const
*Color3	operator * (const ValueType val)
ValueType &	operator[] (const UInt32 uiIndex)
const ValueType &	operator[] (const UInt32 uiIndex) const
bool	equals (const Color3 &other, const ValueType tolerance) const
bool	operator== (const Color3 &other) const
bool	operator!= (const Color3 &other) const
Static Public Member Functions
*static void	convertFromHSV (ValueType *rgbP, const Real32 h, const Real32 s, const Real32 v)
static void	convertToHSV (const ValueType *rgbP, Real32 &h, Real32 &s, Real32 &v)
static UInt32	minPart (const ValueType *rgbP)
static UInt32	maxPart (const ValueType *rgbP)
Static Public Attributes
static const Color3	Null
Protected Attributes
ValueType	_rgb [3]
Private Attributes
UInt8 *	_val

---

Detailed Description

This is a documentation wrapper. Its only purpose is to fool doxygen into thinking of a typedef as a class and to allow you to find all the needed info from this page.

Warning:

The real inheritance is not what you see here.

This is just to give you an idea of the conceptual relations and to help you understand the available methods of this class.

Definition at line 2288 of file dummyClasses.dox.

---

Member Typedef Documentation

typedef UInt8 osg::Color3< UInt8 >::ValueType [inherited]

Definition at line 61 of file OSGColor.h.

---

Member Function Documentation

* static void osg::Color3< UInt8 >::convertFromHSV (  ValueType *  rgbP, const Real32  h, const Real32  s, const Real32  v )  [static, inherited]

static void osg::Color3< UInt8 >::convertToHSV (  const ValueType *  rgbP, Real32 &  h, Real32 &  s, Real32 &  v )  [static, inherited]

static UInt32 osg::Color3< UInt8 >::minPart (  const ValueType *  rgbP  )  [static, inherited]

static UInt32 osg::Color3< UInt8 >::maxPart (  const ValueType *  rgbP  )  [static, inherited]

* osg::Color3< UInt8 >::Color3 (  void   )  [inherited]

osg::Color3< UInt8 >::Color3 (  const Color3< UInt8 > &  source  )  [inherited]

osg::Color3< UInt8 >::Color3 (  ValueType  red, ValueType  green, ValueType  blue )  [inherited]

* void osg::Color3< UInt8 >::clear (  void   )  [inherited]

void osg::Color3< UInt8 >::setValuesRGB (  const ValueType  red, const ValueType  green, const ValueType  blue )  [inherited]

void osg::Color3< UInt8 >::setValuesHSV (  const Real32  h, const Real32  s, const Real32  v )  [inherited]

void osg::Color3< UInt8 >::setRandom (  void   )  [inherited]

void osg::Color3< UInt8 >::setRGB (  UInt32  rgbPack  )  [inherited]

method to set the rgb values (BBGGRR)

void osg::Color3< UInt8 >::setValue (  const Char8 *  szString  )  [inherited]

void osg::Color3< UInt8 >::setValue (  Char8 *  szString  )  [inherited]

* UInt32 osg::Color3< UInt8 >::getRGB (  void   )  const [inherited]

method to get a packed rgb value (BBGGRR)

void osg::Color3< UInt8 >::getValuesRGB (  ValueType &  red, ValueType &  green, ValueType &  blue )  const [inherited]

method to get a packed rgb value (BBGGRR)

ValueType* osg::Color3< UInt8 >::getValuesRGB (  void   )  [inherited]

method to get a packed rgb value (BBGGRR)

const ValueType* osg::Color3< UInt8 >::getValuesRGB (  void   )  const [inherited]

method to get a packed rgb value (BBGGRR)

void osg::Color3< UInt8 >::getValuesHSV (  Real32 &  h, Real32 &  s, Real32 &  v )  const [inherited]

method to get a packed rgb value (BBGGRR)

ValueType osg::Color3< UInt8 >::red (  void   )  const [inherited]

method to get a packed rgb value (BBGGRR)

ValueType osg::Color3< UInt8 >::green (  void   )  const [inherited]

method to get a packed rgb value (BBGGRR)

ValueType osg::Color3< UInt8 >::blue (  void   )  const [inherited]

method to get a packed rgb value (BBGGRR)

* Color3 osg::Color3< UInt8 >::operator * (  const ValueType  val  )  [inherited]

ValueType& osg::Color3< UInt8 >::operator[] (  const UInt32  uiIndex  )  [inherited]

const ValueType& osg::Color3< UInt8 >::operator[] (  const UInt32  uiIndex  )  const [inherited]

bool osg::Color3< UInt8 >::equals (  const Color3< UInt8 > &  other, const ValueType  tolerance )  const [inherited]

bool osg::Color3< UInt8 >::operator== (  const Color3< UInt8 > &  other  )  const [inherited]

bool osg::Color3< UInt8 >::operator!= (  const Color3< UInt8 > &  other  )  const [inherited]

---

Member Data Documentation

UInt8* osg::Color3ub::_val [private]

Definition at line 2288 of file dummyClasses.dox.

const Color3 osg::Color3< UInt8 >::Null [static, inherited]

Definition at line 63 of file OSGColor.h.

ValueType osg::Color3< UInt8 >::_rgb[3] [protected, inherited]

Definition at line 168 of file OSGColor.h.

---

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

• dummyClasses.dox

---