Colour Class Reference

#include <colour.h>

List of all members.

Public Member Functions
	Colour (CLR r, CLR g, CLR b)
	Colour (const CLR &a)
	Colour (const ColourA &a)
CLR	red () const
CLR	green () const
CLR	blue () const
void	add (const Colour &d)
void	add (const ColourA &d)
void	sub (const Colour &d)
void	scale (CLR s)
void	scale (const ColourA &d)
void	scale (const Colour &d)
void	exp ()
void	negExp ()
Colour	scaled (CLR s) const
Colour	scaled (const Colour &d) const
Colour	divided (const Colour &d) const
Colour	scaled (const ColourA &d) const
CLR	norm () const
CLR	minElement () const
CLR	maxElement () const
Colour	operator+ (const Colour &c1) const
Colour	operator * (const CLR d) const
Colour	operator * (const Colour &d) const
Colour	operator/ (const Colour &d) const
Colour	operator- (const Colour &d) const
Static Public Member Functions
Colour	add (const Colour &c1, const Colour &c2)
Colour	sub (const Colour &c1, const Colour &c2)
Colour	sqrt (const Colour &d)
Colour	exp (const Colour &d)
Colour	negExp (const Colour &d)
Static Public Attributes
const char	RGB_LOOP = 3

---

Detailed Description

Colour vector with red, green and blue component.

Author:

Micha Riser

---

Constructor & Destructor Documentation

Colour::Colour (  CLR  r, CLR  g, CLR  b )  [inline]

Construct colour by individual components

Colour::Colour (  const CLR &  a  )  [inline]

Construct gray-value colour. Parameters: a  value for all the rgb components

Colour::Colour (  const ColourA &  a  )  [inline]

Construct rgb colour from ColourA. Alpha value is just ignored.

---

Member Function Documentation

Colour Colour::add (  const Colour &  c1, const Colour &  c2 )  [inline, static]

Adds two colours (componentwise).

void Colour::add (  const ColourA &  d  )  [inline]

Add colour. Parameters: d  colour to add

void Colour::add (  const Colour &  d  )  [inline]

Add colour. Parameters: d  colour to add

Colour Colour::exp (  const Colour &  d  )  [inline, static]

Calculate e^x for each colour component.

void Colour::exp (   )  [inline]

Calculate e^x for each colour components x.

CLR Colour::maxElement (   )  const [inline]

Maximum. Returns: the maximal element of the colour vector

CLR Colour::minElement (   )  const [inline]

Minimum. Returns: the minimal element of the colour vector

void Colour::negExp (   )  [inline]

Calculate e^(-x) for each colour components x.

CLR Colour::norm (   )  const [inline]

Colour norm Returns: a (unspecified) norm of the colour components

void Colour::scale (  const Colour &  d  )  [inline]

Scale colour componentwise. Parameters: d  scaling factors

void Colour::scale (  const ColourA &  d  )  [inline]

Scale colour componentwise. Parameters: d  scaling factors

void Colour::scale (  CLR  s  )  [inline]

Scale colour. Parameters: s  scaling factor

Colour Colour::scaled (  const ColourA &  d  )  const [inline]

Returns: componentwise scaled colour Parameters: d  scaling factors

Colour Colour::scaled (  const Colour &  d  )  const [inline]

Returns: componentwise scaled colour Parameters: d  scaling factors

Colour Colour::scaled (  CLR  s  )  const [inline]

Returns: colour scaled by factor Parameters: s  scaling factor

Colour Colour::sqrt (  const Colour &  d  )  [inline, static]

Calcluate the square root of a colour (componentwise).

Colour Colour::sub (  const Colour &  c1, const Colour &  c2 )  [inline, static]

Subtracts colour c2 from colour c1 (componentwise).

void Colour::sub (  const Colour &  d  )  [inline]

Subtract colour. Parameters: d  colour to subtract

---

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

• colour.h

---