RED GREEN BLUE color. More...

#include "Imagine/Common.h"

Inheritance diagram for Imagine::RGB< T >:

Public Member Functions
	RGB ()
	Empty constructor. More...

	RGB (T v)
	Constructor with constant value. More...

	RGB (T r, T g, T b)
	Constructor with r,g,b values Constructs a RGB of type T. More...

	RGB (const T t[3])
	Constructor from C array. More...

	RGB (const Base &x)
	Copy constructor. More...

template<typename T2 >
	RGB (const FVector< T2, 3 > &x)
	Constructor from other value type Constructs from RGB with different type. More...

template<typename T2 >
	RGB (const FArray< T2, 4 > &x)
	Constructor from RGBA. More...

const T &	b () const
	Read BLUE alias. More...

T &	b ()
	Write BLUE alias. More...

const T &	g () const
	Read GREEN alias. More...

T &	g ()
	Write GREEN alias. More...

	operator T () const
	To greyscale. More...

const T &	r () const
	Read RED alias. More...

T &	r ()
	Write RED alias. More...

Public Member Functions inherited from Imagine::FVector< T, 3 >
	FVector ()
	Empty constructor. More...

	FVector (const T &v)
	Constructor with constant value. More...

	FVector (const T2 t[dim])
	Constructor from C array. More...

	FVector (const FArray< T2, dim > &a)
	Copy constructor. More...

	FVector (T x, T y)
	2D alias. More...

	FVector (T x, T y, T z)
	3D alias. More...

FVector &	fill (const T &v)
	Filling. More...

FVector &	normalize ()
	Euclidean in-place normalization. More...

T	operator* (const FVector &v) const
	Scalar product. More...

FVector	operator* (T s) const
	Scalar multiplication. More...

FVector &	operator*= (T s)
	Scalar in place multiplication. More...

FVector	operator+ (const FVector &v) const
	Addition. More...

FVector	operator+ (T s) const
	Scalar Addition. More...

FVector &	operator+= (const FVector &v)
	In place Addition. More...

FVector &	operator+= (T s)
	Scalar in place Addition. More...

FVector	operator- (const FVector &v) const
	Substraction. More...

FVector	operator- (T s) const
	Scalar Substraction. More...

FVector	operator- () const
	Opposite. More...

FVector &	operator-= (const FVector &v)
	In place Substraction. More...

FVector &	operator-= (T s)
	Scalar in place substractrion. More...

FVector	operator/ (T s) const
	Scalar division. More...

FVector &	operator/= (T s)
	Scalar in place division. More...

FVector &	operator= (const FArray< T2, dim > &b)
	Assignment. More...

T	operator^ (const FVector< T, 2 > &v) const
	2D cross product. More...

FVector< T, 3 >	operator^ (const FVector< T, 3 > &v) const
	3D cross product. More...

const T &	x () const
	Read alias. More...

T &	x ()
	Write alias. More...

const T &	y () const
	Read alias. More...

T &	y ()
	Write alias. More...

const T &	z () const
	Read alias. More...

T &	z ()
	Write alias. More...

Public Member Functions inherited from Imagine::FArray< T, dim >
	FArray ()
	Empty constructor. More...

	FArray (const T &v)
	Constructor with constant value. More...

	FArray (const T2 t[S])
	Constructor from C array. More...

	FArray (const FArray< T2, S > &a)
	Copy constructor. More...

	FArray (T v0, T v1)
	2D alias. More...

	FArray (T v0, T v1, T v2)
	3D alias. More...

	FArray (T v0, T v1, T v2, T v3)
	4D alias. More...

iterator	begin ()
	Begin iterator. More...

const_iterator	begin () const
	Begin const iterator. More...

FArray &	copy (const T2 t[S])
	C array of different type copy. More...

FArray &	copy (const FArray< T2, S > &b)
	Copy. More...

const T *	data () const
	Data pointer (read). More...

T *	data ()
	Data pointer (write). More...

bool	empty () const
	Is empty. More...

iterator	end ()
	End iterator. More...

const_iterator	end () const
	End const iterator. More...

FArray &	fill (const T &v)
	Filling. More...

bool	operator!= (const FArray &b) const
	Inequality test. More...

FArray &	operator= (const FArray< T2, S > &b)
	Assignment. More...

bool	operator== (const FArray &b) const
	Equality test. More...

const T &	operator[] (int i) const
	Read access. More...

T &	operator[] (int i)
	Write access. More...

int	size () const
	Size. More...

Additional Inherited Members
Public Types inherited from Imagine::FArray< T, dim >
typedef const T *	const_iterator
	Const iterator type.

typedef T *	iterator
	Iterator type.

Static Public Member Functions inherited from Imagine::FVector< T, 3 >
static FVector	Zero ()
	Zero vector Vector with constant 0 value. More...

Protected Attributes inherited from Imagine::FArray< T, dim >
T	_data [S]
	internal storage.

Detailed Description

template<typename T>
class Imagine::RGB< T >

RED GREEN BLUE color

Parameters

T	value type

Examples:: Common/test/test.cpp, Graphics/test/example.cpp, Graphics/test/particles.cpp, Graphics/test/test.cpp, and Images/test/test.cpp.

Constructor & Destructor Documentation

template<typename T>

Imagine::RGB< T >::RGB ( )

inline

Constructs an uninitialized RGB of type T

RGB<double> a; // uninitialized

template<typename T>

Imagine::RGB< T >::RGB ( T v )

inlineexplicit

Constructs a RGB of type T, each initialized to v

Parameters

v	value used for initialization

RGB<double> b(.6); // filled with constant value

template<typename T>

Imagine::RGB< T >::RGB	(	T	r,
		T	g,
		T	b
	)

inline

Parameters

r,g,b RED, GREEN, BLUE values

RGB<double> c(.12,.3,.43); // rgb values

template<typename T>

Imagine::RGB< T >::RGB ( const T t[3] )

inlineexplicit

Constructs a RGB of type T, and copies values to it

Parameters

t	C array used for initialization

double t1[]={.2,1.,.23}; // filled from C array

RGB<double> d(t1); // ...

template<typename T>

Imagine::RGB< T >::RGB ( const Base & x )

inline

Constructs from another RGB

Parameters

x	RGB to copy

RGB<double> e(d); // copy constructor

template<typename T>

template<typename T2 >

Imagine::RGB< T >::RGB ( const FVector< T2, 3 > & x )

inline

Parameters

x	RGB to copy

Template Parameters

T2	value type of x

RGB<float> f(e); // from another type

template<typename T>

template<typename T2 >

Imagine::RGB< T >::RGB ( const FArray< T2, 4 > & x )

inline

Constructs from RGBA (ignores a)

Parameters

x	RGBA to copy

Template Parameters

T2	value type of x

RGBA<double>g(.1,.2,.6,.3); // RGBA -> RGB

RGB<float> h(g); // ...

Member Function Documentation

template<typename T>

const T& Imagine::RGB< T >::b ( ) const

inline

Read BLUE alias

Returns: const ref. to BLUE

x=e.b(); // Read BLUE alias

template<typename T>

T& Imagine::RGB< T >::b ( )

inline

Write BLUE alias

Returns: ref. to BLUE

e.b()=x; // Write BLUE alias

template<typename T>

const T& Imagine::RGB< T >::g ( ) const

inline

Read GREEN alias

Returns: const ref. to GREEN

x=e.g(); // Read GREEN alias

template<typename T>

T& Imagine::RGB< T >::g ( )

inline

Write GREEN alias

Returns: ref. to GREEN

e.g()=x; // Write GREEN alias

template<typename T>

Imagine::RGB< T >::operator T ( ) const

inline

Convert to greyscale (grey=0.3*r+0.59*g+0.11*b)

Returns: greyscale value

float grey=float(c); // to greyscale

template<typename T>

const T& Imagine::RGB< T >::r ( ) const

inline

Read RED alias

Returns: const ref. to RED

x=e.r(); // Read RED alias

template<typename T>

T& Imagine::RGB< T >::r ( )

inline

Write RED alias

Returns: ref. to RED

e.r()=x; // Write RED alias

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

/Users/pascal/ImagineQt2/Imagine/Common/src/Imagine/Common/Color.h

Public Member Functions

Additional Inherited Members

Detailed Description

template<typename T> class Imagine::RGB< T >

Constructor & Destructor Documentation

Member Function Documentation

template<typename T>
class Imagine::RGB< T >