---

osg::Color3< ValueTypeT > Class Template Reference

Color3. More...

#include <OSGColor.h>

Collaboration diagram for osg::Color3< ValueTypeT >:

[legend]List of all members.

Public Types
typedef ValueTypeT	ValueType
Public Methods
Constructors
	Color3 (void)
	Constructor.
	Color3 (const Color3 &source)
	Copy Constructor.
	Color3 (ValueType red, ValueType green, ValueType blue)
	Constructor.
Destructors
	~Color3 (void)
	Destructor.
Set
void	clear (void)
void	setValuesRGB (ValueType red, ValueType green, ValueType blue)
void	setValuesHSV (Real32 h, Real32 s, Real32 v)
void	setRandom (void)
void	setRGB (UInt32 rgbPack)
	method to set the rgb values (AABBGGRR)
void	setValue (const char *szString)
void	setValue (char *szString)
Get
UInt32	getRGB (void) const
	method to get a packed rgb value (AABBGGRR)
void	getValuesRGB (ValueType &red, ValueType &green, ValueType &blue)
	method to get a packed rgb value (AABBGGRR)
void	getValuesHSV (Real32 &h, Real32 &s, Real32 &v)
	method to get a packed rgb value (AABBGGRR)
ValueType	red (void) const
	method to get a packed rgb value (AABBGGRR)
ValueType	green (void) const
	method to get a packed rgb value (AABBGGRR)
ValueType	blue (void) const
	method to get a packed rgb value (AABBGGRR)
ValueType *	getValuesRGB (void)
	method to get a packed rgb value (AABBGGRR)
const ValueType *	getValuesRGB (void) const
	method to get a packed rgb value (AABBGGRR)
Operators
Color3	operator * (const ValueType val)
ValueType &	operator[] (UInt32 uiIndex)
const ValueType &	operator[] (UInt32 uiIndex) const
Color3 &	operator= (const Color3 &source)
	assignment
bool	equals (const Color3 &other, ValueType tolerance) const
	equal within tolerance
bool	operator== (const Color3 &other) const
	equal
bool	operator!= (const Color3 &other) const
	unequal
Static Public Methods
Class Specific
void	convertFromHSV (ValueType *rgbP, Real32 h, Real32 s, Real32 v)
void	convertToHSV (const ValueType *rgbP, Real32 &h, Real32 &s, Real32 &v)
UInt32	minPart (const ValueType *rgbP)
UInt32	maxPart (const ValueType *rgbP)
Static Public Attributes
const Color3	Null
Protected Attributes
ValueType	_rgb [3]

---

Detailed Description

template<class ValueTypeT>
class osg::Color3< ValueTypeT >

Color3.

---

Member Typedef Documentation

template<class ValueTypeT> typedef ValueTypeT osg::Color3< ValueTypeT >::ValueType

---

Constructor & Destructor Documentation

template<class ValueTypeT> osg::Color3< ValueTypeT >::Color3 (  void    )  [inline]

Constructor.

template<class ValueTypeT> osg::Color3< ValueTypeT >::Color3 (  const Color3< ValueTypeT > &    source )  [inline]

Copy Constructor.

template<class ValueTypeT> osg::Color3< ValueTypeT >::Color3 (  ValueType    red, ValueType    green, ValueType    blue )  [inline]

Constructor.

template<class ValueTypeT> osg::Color3< ValueTypeT >::~Color3 (  void    )  [inline]

Destructor.

---

Member Function Documentation

template<class ValueTypeT> void osg::Color3< ValueTypeT >::convertFromHSV (  ValueType *    rgbP, Real32    h, Real32    s, Real32    v )  [inline, static]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::convertToHSV (  const ValueType *    rgbP, Real32 &    h, Real32 &    s, Real32 &    v )  [inline, static]

template<class ValueTypeT> UInt32 osg::Color3< ValueTypeT >::minPart (  const ValueType *    rgbP )  [inline, static]

template<class ValueTypeT> UInt32 osg::Color3< ValueTypeT >::maxPart (  const ValueType *    rgbP )  [inline, static]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::clear (  void    )  [inline]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::setValuesRGB (  ValueType    red, ValueType    green, ValueType    blue )  [inline]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::setValuesHSV (  Real32    h, Real32    s, Real32    v )  [inline]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::setRandom (  void    )  [inline]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::setRGB (  UInt32    rgbPack )  [inline]

method to set the rgb values (AABBGGRR)

template<class ValueTypeT> void osg::Color3< ValueTypeT >::setValue (  const char *    szString )  [inline]

template<class ValueTypeT> void osg::Color3< ValueTypeT >::setValue (  char *    szString )  [inline]

template<class ValueTypeT> UInt32 osg::Color3< ValueTypeT >::getRGB (  void    )  const [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> void osg::Color3< ValueTypeT >::getValuesRGB (  ValueType &    red, ValueType &    green, ValueType &    blue )  [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> void osg::Color3< ValueTypeT >::getValuesHSV (  Real32 &    h, Real32 &    s, Real32 &    v )  [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> Color3< ValueTypeT >::ValueType osg::Color3< ValueTypeT >::red (  void    )  const [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> Color3< ValueTypeT >::ValueType osg::Color3< ValueTypeT >::green (  void    )  const [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> Color3< ValueTypeT >::ValueType osg::Color3< ValueTypeT >::blue (  void    )  const [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> Color3< ValueTypeT >::ValueType * osg::Color3< ValueTypeT >::getValuesRGB (  void    )  [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> const Color3< ValueTypeT >::ValueType * osg::Color3< ValueTypeT >::getValuesRGB (  void    )  const [inline]

method to get a packed rgb value (AABBGGRR)

template<class ValueTypeT> Color3< ValueTypeT > osg::Color3< ValueTypeT >::operator * (  const ValueType    val )  [inline]

template<class ValueTypeT> Color3< ValueTypeT >::ValueType & osg::Color3< ValueTypeT >::operator[] (  UInt32    uiIndex )  [inline]

template<class ValueTypeT> const Color3< ValueTypeT >::ValueType & osg::Color3< ValueTypeT >::operator[] (  UInt32    uiIndex )  const [inline]

template<class ValueTypeT> Color3< ValueTypeT > & osg::Color3< ValueTypeT >::operator= (  const Color3< ValueTypeT > &    other )  [inline]

assignment

template<class ValueTypeT> bool osg::Color3< ValueTypeT >::equals (  const Color3< ValueTypeT > &    other, ValueType    tolerance )  const [inline]

equal within tolerance

template<class ValueTypeT> bool osg::Color3< ValueTypeT >::operator== (  const Color3< ValueTypeT > &    other )  const [inline]

equal

template<class ValueTypeT> bool osg::Color3< ValueTypeT >::operator!= (  const Color3< ValueTypeT > &    other )  const [inline]

unequal

---

Member Data Documentation

template<class ValueTypeT> const Color3< ValueTypeT > osg::Color3< ValueTypeT >::Null [static]

template<class ValueTypeT> ValueType osg::Color3< ValueTypeT >::_rgb[3] [protected]

---

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

• OSGColor.h
• OSGColor.inl

---