GEO::GenColor< T > Class Template Reference

A generic color type. More...

#include <geogram/image/color.h>

Inheritance diagram for GEO::GenColor< T >:

Public Types
typedef vecng< 4, T >	superclass
	The superclass type.
Public Types inherited from GEO::vecng< 4, T >
typedef vecng< dim, T >	vector_type
	This vector type.
typedef T	value_type
	The type of the vector coordinates.

Public Member Functions
	GenColor (const superclass &rhs)
	GenColor copy constructor.
	GenColor (const T *rhs)
	GenColor constructor from T array.
	GenColor (T r=0, T g=0, T b=0, T a=1)
	GenColor constructor from 4 parameters.
GenColor &	operator= (const superclass &rhs)
	assignment operator.
T	r () const
	Gets the red component.
T	g () const
	Gets the green component.
T	b () const
	Gets the blue component.
T	a () const
	Gets the alpha component (transparency).
void	set_r (T r)
	Sets the red component.
void	set_g (T g)
	Sets the green component.
void	set_b (T b)
	Sets the blue component.
void	set_a (T a)
	Sets the alpha component (transparency).
Public Member Functions inherited from GEO::vecng< 4, T >
	vecng ()
	Default vector constructor.
	vecng (T x_in, T y_in, T z_in, T w_in)
	Constructs a vector from coordinates.
template<class T2 >
	vecng (const vecng< dim, T2 > &v)
	Constructs a vector by copy.
template<class T2 >
	vecng (const T2 *v)
	Constructs a vector from an array.
	vecng (const std::initializer_list< T > &Vi)
T	length2 () const
	Gets the squared length of the vector.
T	length () const
	Gets the length of the vector.
T	distance2 (const vector_type &v) const
T	distance (const vector_type &v) const
index_t	dimension () const
	Gets the vector dimension.
vector_type &	operator+= (const vector_type &v)
vector_type &	operator-= (const vector_type &v)
template<class T2 >
vector_type &	operator*= (T2 s)
	Multiplies by a scalar in place.
template<class T2 >
vector_type &	operator/= (T2 s)
	Divides by a scalar in place.
vector_type	operator+ (const vector_type &v) const
vector_type	operator- (const vector_type &v) const
template<class T2 >
vector_type	operator* (T2 s) const
	Multiplies a vector by a scalar.
template<class T2 >
vector_type	operator/ (T2 s) const
	Divides a vector by a scalar.
vector_type	operator- () const
	Negates a vector.
T *	data ()
	Gets modifiable vector data.
const T *	data () const
	Gets non-modifiable vector data.
T &	operator[] (index_t i)
	Gets a modifiable vector coordinate.
const T &	operator[] (index_t i) const
	Gets a non-modifiable vector coordinate.

Additional Inherited Members
Public Attributes inherited from GEO::vecng< 4, T >
T	x
	Vector x coordinate.
T	y
	Vector y coordinate.
T	z
	Vector z coordinate.
T	w
	Vector w coordinate.
Static Public Attributes inherited from GEO::vecng< 4, T >
static constexpr index_t	dim = 4
	The dimension of the vector.

Detailed Description

template<class T>
class GEO::GenColor< T >

A generic color type.

Template Parameters

T	type of the components

Definition at line 57 of file color.h.

Member Typedef Documentation

superclass

template<class T >

typedef vecng<4,T> GEO::GenColor< T >::superclass

The superclass type.

Definition at line 62 of file color.h.

Constructor & Destructor Documentation

GenColor() [1/3]

template<class T >

GEO::GenColor< T >::GenColor ( const superclass &  rhs )

inline

GenColor copy constructor.

Parameters

[in]

rhs

the GenColor to be copied.

Definition at line 68 of file color.h.

GenColor() [2/3]

template<class T >

GEO::GenColor< T >::GenColor ( const T *  rhs )

inline

GenColor constructor from T array.

Parameters

[in]

rhs

a pointer to an array of 4 Ts

Definition at line 75 of file color.h.

GenColor() [3/3]

template<class T >

GEO::GenColor< T >::GenColor ( T  r = 0, T  g = 0, T  b = 0, T  a = 1  )

inline

GenColor constructor from 4 parameters.

Parameters

[in]

r,g,b,a

the components of the color

Definition at line 82 of file color.h.

Member Function Documentation

a()

template<class T >

T GEO::GenColor< T >::a ( ) const

inline

Gets the alpha component (transparency).

Returns

the value of the alpha component

Definition at line 125 of file color.h.

b()

template<class T >

T GEO::GenColor< T >::b ( ) const

inline

Gets the blue component.

Returns

the value of the blue component

Definition at line 117 of file color.h.

g()

template<class T >

T GEO::GenColor< T >::g ( ) const

inline

Gets the green component.

Returns

the value of the green component

Definition at line 109 of file color.h.

operator=()

template<class T >

GenColor & GEO::GenColor< T >::operator= ( const superclass &  rhs )

inline

assignment operator.

Parameters

[in]

rhs

the GenColor to be copied

Returns

the new value of this GenColor after assignment

Definition at line 92 of file color.h.

r()

template<class T >

T GEO::GenColor< T >::r ( ) const

inline

Gets the red component.

Returns

the value of the red component

Definition at line 101 of file color.h.

set_a()

template<class T >

void GEO::GenColor< T >::set_a ( T  a )

inline

Sets the alpha component (transparency).

Parameters

[in]

a

the value of the alpha component

Definition at line 157 of file color.h.

set_b()

template<class T >

void GEO::GenColor< T >::set_b ( T  b )

inline

Sets the blue component.

Parameters

[in]

b

the value of the blue component

Definition at line 149 of file color.h.

set_g()

template<class T >

void GEO::GenColor< T >::set_g ( T  g )

inline

Sets the green component.

Parameters

[in]

g

the value of the green component

Definition at line 141 of file color.h.

set_r()

template<class T >

void GEO::GenColor< T >::set_r ( T  r )

inline

Sets the red component.

Parameters

[in]

r

the value of the red component

Definition at line 133 of file color.h.

---

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

• geogram/image/color.h