represent a color with components of given type and color and alpha model as specified. More...

#include <color.h>

Inheritance diagram for cgv::media::color< T, cm, am >:

Public Types
typedef T	component_type
	type of color components

Public Types inherited from cgv::media::color_base< T, cm, am >
typedef T	component_type
	type of color components

Public Member Functions
	color ()
	standard constructor does not initialize components

	color (const T &c)
	set all components to given value

	color (const T &c0, const T &c1)
	set first two components to given values

	color (const T &c0, const T &c1, const T &c2)
	set first three components to given values

	color (const T &c0, const T &c1, const T &c2, const T &c3)
	set all four components to given values

	color (const color< T, cm > &c, T a)
	construct from non-alpha color plus alpha

template<typename T2 , ColorModel cm2, AlphaModel am2>
	color (const color< T2, cm2, am2 > &c2)
	copy constructor uses color conversion if necessary

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am > &	operator= (const color< T2, cm2, am2 > &c2)
	assign to color with potential color conversion

color< T, cm, am > &	operator= (const T &c)
	assign all components including alpha to `c`

color< T, cm > &	drop_alpha ()
	drop the alpha component if any by a cast operator

const color< T, cm > &	drop_alpha () const

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am > &	operator*= (const color< T2, cm2, am2 > &c2)
	multiply with color

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am >	operator* (const color< T2, cm2, am2 > &c2)
	post multiply with color

color< T, cm, am > &	operator*= (const T &c)
	multiply with constant

template<typename T2 >
color< typename type::func::promote< T, T2 >::type, cm, am >	operator* (const T2 &c) const
	post multiply with constant

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am > &	operator+= (const color< T2, cm2, am2 > &c2)
	add color

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am >	operator+ (const color< T2, cm2, am2 > &c2)
	add color

color< T, cm, am > &	operator+= (const T &c)
	add constant

color< T, cm, am >	operator+ (const T &c)
	add constant

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am > &	operator-= (const color< T2, cm2, am2 > &c2)
	subtract color

template<typename T2 , ColorModel cm2, AlphaModel am2>
color< T, cm, am >	operator- (const color< T2, cm2, am2 > &c2)
	subtract color

color< T, cm, am > &	operator-= (const T &c)
	subtract constant

color< T, cm, am >	operator- (const T &c)
	subtract constant

void	clamp (const T &mn=0, const T &mx=color_one< T >::value(), bool skip_alpha=false)
	clamp to the given range, which defaults to [0,1] of the component type

T &	operator[] (unsigned int i)
	access to components

const T &	operator[] (unsigned int i) const
	const access to components

Public Member Functions inherited from cgv::media::extinction_alpha_interface< color< T, cm, am > >
T	extinction () const
	convert alpha to extinction

Public Member Functions inherited from cgv::media::transparency_alpha_interface< color< T, cm, am > >
T	transparency () const
	convert alpha to transparency

Public Member Functions inherited from cgv::media::opacity_alpha_interface< color< T, cm, am > >
T	opacity () const
	convert alpha to opacity

Public Member Functions inherited from cgv::media::xyz_color_interface< color< T, cm, am > >
T	X () const
	convert color to XYZ and return X component

T	Y () const
	convert color to XYZ and return Y component

T	Z () const
	convert color to XYZ and return Z component

Public Member Functions inherited from cgv::media::hls_color_interface< color< T, cm, am > >
T	H () const
	convert color to HLS and return H component

T	L () const
	convert color to HLS and return L component

T	S () const
	convert color to HLS and return S component

Public Member Functions inherited from cgv::media::rgb_color_interface< color< T, cm, am > >
T	R () const
	convert color to RGB and return R component

T	G () const
	convert color to RGB and return G component

T	B () const
	convert color to RGB and return B component

Public Member Functions inherited from cgv::media::color_base< T, cm, am >
	color_base ()
	standard constructor does not initialize components

	color_base (const color_base< T2, cm2, am2 > &c2)
	copy constructor uses color conversion if necessary

T &	at (unsigned int i)
	access to components

const T &	at (unsigned int i) const
	const access to components

T &	alpha ()
	return alpha component

const T &	alpha () const
	return alpha component

Static Public Attributes
static const ColorModel	clr_mod = cm
	static and const access to color model

static const AlphaModel	alp_mod = am
	static and const access to alpha model

static const unsigned int	nr_color_components = color_base<T,cm,am>::nr_color_components
	static and const access to number of color components

static const unsigned int	nr_alpha_components = color_base<T, cm, am>::nr_alpha_components
	static and const access to number of alpha components

static const unsigned int	nr_components = color_base<T, cm, am>::nr_components
	static and const access to total number of components

Static Public Attributes inherited from cgv::media::color_base< T, cm, am >
static const unsigned int	nr_color_components
	static and const access to number of color components

static const unsigned int	nr_alpha_components
	static and const access to number of alpha components

static const unsigned int	nr_components
	static and const access to total number of components

Additional Inherited Members
Protected Attributes inherited from cgv::media::color_base< T, cm, am >
T	components [nr_components]

Detailed Description

template<typename T, ColorModel cm, AlphaModel am>
class cgv::media::color< T, cm, am >

represent a color with components of given type and color and alpha model as specified.

Definition at line 574 of file color.h.

Member Typedef Documentation

◆ component_type

template<typename T , ColorModel cm, AlphaModel am>

typedef T cgv::media::color< T, cm, am >::component_type

type of color components

Definition at line 588 of file color.h.

Constructor & Destructor Documentation

◆ color() [1/7]

template<typename T , ColorModel cm, AlphaModel am>

cgv::media::color< T, cm, am >::color ( )

inline

standard constructor does not initialize components

Definition at line 590 of file color.h.

◆ color() [2/7]

template<typename T , ColorModel cm, AlphaModel am>

cgv::media::color< T, cm, am >::color ( const T & c )

inline

set all components to given value

Definition at line 592 of file color.h.

◆ color() [3/7]

template<typename T , ColorModel cm, AlphaModel am>

cgv::media::color< T, cm, am >::color	(	const T &	c0,
		const T &	c1
	)

inline

set first two components to given values

Definition at line 594 of file color.h.

References cgv::media::color< T, cm, am >::nr_components.

◆ color() [4/7]

template<typename T , ColorModel cm, AlphaModel am>

cgv::media::color< T, cm, am >::color	(	const T &	c0,
		const T &	c1,
		const T &	c2
	)

inline

set first three components to given values

Definition at line 600 of file color.h.

References cgv::media::color< T, cm, am >::nr_components.

◆ color() [5/7]

template<typename T , ColorModel cm, AlphaModel am>

cgv::media::color< T, cm, am >::color	(	const T &	c0,
		const T &	c1,
		const T &	c2,
		const T &	c3
	)

inline

set all four components to given values

Definition at line 608 of file color.h.

References cgv::media::color< T, cm, am >::nr_components.

◆ color() [6/7]

template<typename T , ColorModel cm, AlphaModel am>

cgv::media::color< T, cm, am >::color	(	const color< T, cm > &	c,
		T	a
	)

inline

construct from non-alpha color plus alpha

Definition at line 618 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_color_components.

◆ color() [7/7]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

cgv::media::color< T, cm, am >::color ( const color< T2, cm2, am2 > & c2 )

inline

copy constructor uses color conversion if necessary

Definition at line 625 of file color.h.

Member Function Documentation

◆ clamp()

template<typename T , ColorModel cm, AlphaModel am>

void cgv::media::color< T, cm, am >::clamp	(	const T &	mn = `0`,
		const T &	mx = `color_one<T>::value()`,
		bool	skip_alpha = `false`
	)

inline

clamp to the given range, which defaults to [0,1] of the component type

Definition at line 726 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), cgv::media::color< T, cm, am >::nr_color_components, and cgv::media::color< T, cm, am >::nr_components.

◆ drop_alpha() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm > & cgv::media::color< T, cm, am >::drop_alpha ( )

inline

drop the alpha component if any by a cast operator

Definition at line 640 of file color.h.

◆ drop_alpha() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

const color< T, cm > & cgv::media::color< T, cm, am >::drop_alpha ( ) const

inline

Definition at line 641 of file color.h.

◆ operator*() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > cgv::media::color< T, cm, am >::operator* ( const color< T2, cm2, am2 > & c2 )

inline

post multiply with color

Definition at line 652 of file color.h.

◆ operator*() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 >

color< typename type::func::promote< T, T2 >::type, cm, am > cgv::media::color< T, cm, am >::operator* ( const T2 & c ) const

inline

post multiply with constant

Definition at line 665 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator*=() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator*= ( const color< T2, cm2, am2 > & c2 )

inline

multiply with color

Definition at line 644 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator*=() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator*= ( const T & c )

inline

multiply with constant

Definition at line 658 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator+() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > cgv::media::color< T, cm, am >::operator+ ( const color< T2, cm2, am2 > & c2 )

inline

add color

Definition at line 681 of file color.h.

◆ operator+() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm, am > cgv::media::color< T, cm, am >::operator+ ( const T & c )

inline

add constant

Definition at line 693 of file color.h.

◆ operator+=() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator+= ( const color< T2, cm2, am2 > & c2 )

inline

add color

Definition at line 673 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator+=() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator+= ( const T & c )

inline

add constant

Definition at line 687 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator-() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > cgv::media::color< T, cm, am >::operator- ( const color< T2, cm2, am2 > & c2 )

inline

subtract color

Definition at line 708 of file color.h.

◆ operator-() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm, am > cgv::media::color< T, cm, am >::operator- ( const T & c )

inline

subtract constant

Definition at line 720 of file color.h.

◆ operator-=() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator-= ( const color< T2, cm2, am2 > & c2 )

inline

subtract color

Definition at line 700 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator-=() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator-= ( const T & c )

inline

subtract constant

Definition at line 714 of file color.h.

References cgv::media::color_base< T, cm, am >::at(), and cgv::media::color< T, cm, am >::nr_components.

◆ operator=() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

template<typename T2 , ColorModel cm2, AlphaModel am2>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator= ( const color< T2, cm2, am2 > & c2 )

inline

assign to color with potential color conversion

Definition at line 630 of file color.h.

◆ operator=() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

color< T, cm, am > & cgv::media::color< T, cm, am >::operator= ( const T & c )

inline

assign all components including alpha to c

Definition at line 635 of file color.h.

References cgv::media::color< T, cm, am >::nr_components.

◆ operator[]() [1/2]

template<typename T , ColorModel cm, AlphaModel am>

T & cgv::media::color< T, cm, am >::operator[] ( unsigned int i )

inline

access to components

Definition at line 735 of file color.h.

References cgv::media::color_base< T, cm, am >::at().

◆ operator[]() [2/2]

template<typename T , ColorModel cm, AlphaModel am>

const T & cgv::media::color< T, cm, am >::operator[] ( unsigned int i ) const

inline

const access to components

Definition at line 737 of file color.h.

References cgv::media::color_base< T, cm, am >::at().

Member Data Documentation

◆ alp_mod

template<typename T , ColorModel cm, AlphaModel am>

const AlphaModel cgv::media::color< T, cm, am >::alp_mod = am

static

static and const access to alpha model

Definition at line 580 of file color.h.

◆ clr_mod

template<typename T , ColorModel cm, AlphaModel am>

const ColorModel cgv::media::color< T, cm, am >::clr_mod = cm

static

static and const access to color model

Definition at line 578 of file color.h.

◆ nr_alpha_components

template<typename T , ColorModel cm, AlphaModel am>

const unsigned int cgv::media::color< T, cm, am >::nr_alpha_components = color_base<T, cm, am>::nr_alpha_components

static

static and const access to number of alpha components

Definition at line 584 of file color.h.

◆ nr_color_components

template<typename T , ColorModel cm, AlphaModel am>

const unsigned int cgv::media::color< T, cm, am >::nr_color_components = color_base<T,cm,am>::nr_color_components

static

static and const access to number of color components

Definition at line 582 of file color.h.

Referenced by cgv::media::color< T, cm, am >::clamp(), and cgv::media::color< T, cm, am >::color().

◆ nr_components

template<typename T , ColorModel cm, AlphaModel am>

const unsigned int cgv::media::color< T, cm, am >::nr_components = color_base<T, cm, am>::nr_components

static

static and const access to total number of components

Definition at line 586 of file color.h.

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

cgv/media/color.h

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ component_type

Constructor & Destructor Documentation

◆ color() [1/7]

◆ color() [2/7]

◆ color() [3/7]

◆ color() [4/7]

◆ color() [5/7]

◆ color() [6/7]

◆ color() [7/7]

Member Function Documentation

◆ clamp()

◆ drop_alpha() [1/2]

◆ drop_alpha() [2/2]

◆ operator*() [1/2]

◆ operator*() [2/2]

◆ operator*=() [1/2]

◆ operator*=() [2/2]

◆ operator+() [1/2]

◆ operator+() [2/2]

◆ operator+=() [1/2]

◆ operator+=() [2/2]

◆ operator-() [1/2]

◆ operator-() [2/2]

◆ operator-=() [1/2]

◆ operator-=() [2/2]

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ operator[]() [1/2]

◆ operator[]() [2/2]

Member Data Documentation

◆ alp_mod

◆ clr_mod

◆ nr_alpha_components

◆ nr_color_components

◆ nr_components