Floating point color description class (for float). More...

#include <color.h>

Inheritance diagram for clan::Colorf:

Public Types
typedef float	datatype

Public Member Functions
Construction
	Colorf ()
	Constructs a color. More...

	Colorf (float r, float g, float b, float a=1.0f)
	Constructs a color. More...

	Colorf (const float *array_rgba)
	Constructs a color. More...

	Colorf (unsigned char r, unsigned char g, unsigned char b, unsigned char a=255)
	Constructs a color. More...

	Colorf (int r, int g, int b, int a=255)
	Constructs a color. More...

	Colorf (const Color &color)

	Colorf (const std::string &hexstr)
	Constructs a color. More...

Attributes
float	get_red () const
	Get Red. More...

float	get_green () const
	Get Green. More...

float	get_blue () const
	Get Blue. More...

float	get_alpha () const
	Get Alpha. More...

Operations
void	normalize ()
	Normalize the color by ensuring that all color values lie inbetween (0.0, 1.0) More...

void	set_alpha (float value)
	Set alpha color component, in the range 0-1. More...

void	set_red (float value)
	Set red color component, in the range 0-1. More...

void	set_green (float value)
	Set green color component, in the range 0-1. More...

void	set_blue (float value)
	Set blue color component, in the range 0-1. More...

bool	operator== (const Colorf &c) const
	Color == Color operator (deep compare) More...

bool	operator!= (const Colorf &c) const
	Color != Color operator (deep compare) More...

	operator Color () const
	Type conversion operator. More...

Attributes
Vec4< float > &	normalize3 ()
	Normalizes this vector (not taking into account the w ordinate) More...

Vec4< float > &	normalize4 ()
	Normalizes this vector (taking into account the w ordinate) More...

float	dot3 (const Vec4< float > &vector) const
	Dot products this vector with an other vector (not taking into account the w ordinate). More...

float	dot4 (const Vec4< float > &vector) const
	Dot products this vector with an other vector (taking into account the w ordinate). More...

Vec4< float > &	cross3 (const Vec4< float > &vector)
	Calculate the cross product between this vector and an other vector (not taking into account the w ordinate). More...

Vec4< float > &	rotate3 (const Angle &angle, const Vec4< float > &axis)
	Rotate this vector around an axis. Same as glRotate[f\|d](angle, a);. More...

Vec4< float > &	round ()
	Rounds all components on this vector. More...

bool	is_equal (const Vec4< float > &other, floatepsilon) const
	Returns true if equal within the bounds of an epsilon. More...

*float	length3 () const
	Returns the length (magnitude) of this vector (not taking into account the w ordinate). More...

*float	length4 () const
	Returns the length (magnitude) of this vector (taking into account the w ordinate). More...

Angle	angle3 (const Vec4< float > &vector) const
	Calculate the angle between this vector and an other vector (not taking into account the w ordinate). More...

float	distance3 (const Vec4< float > &vector) const
	Calculate the distance between this vector and an other vector (not taking into account the w ordinate). More...

float	distance4 (const Vec4< float > &vector) const
	Calculate the distance between this vector and an other vector (taking into account the w ordinate). More...

Operators
void	operator+= (const Vec4< float > &vector)
	+= operator. More...

void	operator+= (floatvalue)
	+= operator. More...

void	operator-= (const Vec4< float > &vector)
	-= operator. More...

void	operator-= (floatvalue)
	-= operator. More...

Vec4< float >	operator- () const
	operator. More...

void	operator*= (const Vec4< float > &vector)
	*= operator. More...

void	operator*= (floatvalue)
	*= operator. More...

void	operator/= (const Vec4< float > &vector)
	/= operator. More...

void	operator/= (floatvalue)
	/= operator. More...

bool	operator== (const Vec4< float > &vector) const
	== operator. More...

bool	operator!= (const Vec4< float > &vector) const
	!= operator. More...

bool	operator< (const Vec4< float > &vector) const
	< operator. More...

Static Public Member Functions
static Vec4< float >	cross3 (const Vec4< float > &vector1, const Vec4< float > &vector2)
	Calculate the cross product between two vectors (not taking into account the w ordinate). More...

static float	dot3 (const Vec4< float > &vector1, const Vec4< float > &vector2)
	Dot products between two vectors (not taking into account the w ordinate). More...

static float	dot4 (const Vec4< float > &vector1, const Vec4< float > &vector2)
	Dot products between two vectors (taking into account the w ordinate). More...

static bool	is_equal (const Vec4< float > &first, const Vec4< float > &second, floatepsilon)
	Returns true if equal within the bounds of an epsilon. More...

static Vec4< float >	normalize3 (const Vec4< float > &vector)
	Normalizes a vector (not taking into account the w ordinate) More...

static Vec4< float >	normalize4 (const Vec4< float > &vector)
	Normalizes a vector (taking into account the w ordinate) More...

static Vec4< float >	rotate3 (const Vec4< float > &vector, const Angle &angle, const Vec4< float > &axis)
	Rotate a vector around an axis. Same as glRotate[f\|d](angle, a);. More...

static Vec4< float >	round (const Vec4< float > &vector)
	Rounds all components on a vector. More...

Public Attributes
union {
Type clan::Vec4< Type >::r

Type clan::Vec4< Type >::s

Type clan::Vec4< Type >::x

};

union {
Type clan::Vec4< Type >::g

Type clan::Vec4< Type >::t

Type clan::Vec4< Type >::y

};

union {
Type clan::Vec4< Type >::b

Type clan::Vec4< Type >::u

Type clan::Vec4< Type >::z

};

union {
Type clan::Vec4< Type >::a

Type clan::Vec4< Type >::v

Type clan::Vec4< Type >::w

};

float	a

float	b

float	g

float	r

float	s

float	t

float	u

float	v

float	w

float	x

float	y

float	z

Static Public Attributes
Statics
static Colorf	aliceblue

static Colorf	antiquewhite

static Colorf	aqua

static Colorf	aquamarine

static Colorf	azure

static Colorf	beige

static Colorf	bisque

static Colorf	black

static Colorf	blanchedalmond

static Colorf	blue

static Colorf	blueviolet

static Colorf	brown

static Colorf	burlywood

static Colorf	cadetblue

static Colorf	chartreuse

static Colorf	chocolate

static Colorf	coral

static Colorf	cornflowerblue

static Colorf	cornsilk

static Colorf	crimson

static Colorf	cyan

static Colorf	darkblue

static Colorf	darkcyan

static Colorf	darkgoldenrod

static Colorf	darkgray

static Colorf	darkgreen

static Colorf	darkgrey

static Colorf	darkkhaki

static Colorf	darkmagenta

static Colorf	darkolivegreen

static Colorf	darkorange

static Colorf	darkorchid

static Colorf	darkred

static Colorf	darksalmon

static Colorf	darkseagreen

static Colorf	darkslateblue

static Colorf	darkslategray

static Colorf	darkslategrey

static Colorf	darkturquoise

static Colorf	darkviolet

static Colorf	deeppink

static Colorf	deepskyblue

static Colorf	dimgray

static Colorf	dimgrey

static Colorf	dodgerblue

static Colorf	firebrick

static Colorf	floralwhite

static Colorf	forestgreen

static Colorf	fuchsia

static Colorf	gainsboro

static Colorf	ghostwhite

static Colorf	gold

static Colorf	goldenrod

static Colorf	gray

static Colorf	grey

static Colorf	green

static Colorf	greenyellow

static Colorf	honeydew

static Colorf	hotpink

static Colorf	indianred

static Colorf	indigo

static Colorf	ivory

static Colorf	khaki

static Colorf	lavender

static Colorf	lavenderblush

static Colorf	lawngreen

static Colorf	lemonchiffon

static Colorf	lightblue

static Colorf	lightcoral

static Colorf	lightcyan

static Colorf	lightgoldenrodyellow

static Colorf	lightgray

static Colorf	lightgreen

static Colorf	lightgrey

static Colorf	lightpink

static Colorf	lightsalmon

static Colorf	lightseagreen

static Colorf	lightskyblue

static Colorf	lightslategray

static Colorf	lightslategrey

static Colorf	lightsteelblue

static Colorf	lightyellow

static Colorf	lime

static Colorf	limegreen

static Colorf	linen

static Colorf	magenta

static Colorf	maroon

static Colorf	mediumaquamarine

static Colorf	mediumblue

static Colorf	mediumorchid

static Colorf	mediumpurple

static Colorf	mediumseagreen

static Colorf	mediumslateblue

static Colorf	mediumspringgreen

static Colorf	mediumturquoise

static Colorf	mediumvioletred

static Colorf	midnightblue

static Colorf	mintcream

static Colorf	mistyrose

static Colorf	moccasin

static Colorf	navajowhite

static Colorf	navy

static Colorf	oldlace

static Colorf	olive

static Colorf	olivedrab

static Colorf	orange

static Colorf	orangered

static Colorf	orchid

static Colorf	palegoldenrod

static Colorf	palegreen

static Colorf	paleturquoise

static Colorf	palevioletred

static Colorf	papayawhip

static Colorf	peachpuff

static Colorf	peru

static Colorf	pink

static Colorf	plum

static Colorf	powderblue

static Colorf	purple

static Colorf	red

static Colorf	rosybrown

static Colorf	royalblue

static Colorf	saddlebrown

static Colorf	salmon

static Colorf	sandybrown

static Colorf	seagreen

static Colorf	seashell

static Colorf	sienna

static Colorf	silver

static Colorf	skyblue

static Colorf	slateblue

static Colorf	slategray

static Colorf	slategrey

static Colorf	snow

static Colorf	springgreen

static Colorf	steelblue

static Colorf	tan

static Colorf	teal

static Colorf	thistle

static Colorf	tomato

static Colorf	turquoise

static Colorf	violet

static Colorf	wheat

static Colorf	white

static Colorf	whitesmoke

static Colorf	yellow

static Colorf	yellowgreen

static Colorf	transparent
	rgba(0, 0, 0, 0). More...

static Colorf	gray10

static Colorf	gray20

static Colorf	gray30

static Colorf	gray40

static Colorf	gray50

static Colorf	gray60

static Colorf	gray70

static Colorf	gray80

static Colorf	gray90

Detailed Description

Floating point color description class (for float).

Member Typedef Documentation

typedef float clan::Vec4< float >::datatype

inherited

Member Function Documentation

Angle clan::Vec4< float >::angle3 ( const Vec4< float > & vector ) const

inherited

Calculate the angle between this vector and an other vector (not taking into account the w ordinate).

Parameters

vector = Second vector used to calculate angle.

Returns: The angle between the two vectors.

static Vec4<float > clan::Vec4< float >::cross3	(	const Vec4< float > &	vector1,
		const Vec4< float > &	vector2
	)

staticinherited

Calculate the cross product between two vectors (not taking into account the w ordinate).

= The first vector = The second vector

Returns: = Cross product

Vec4<float >& clan::Vec4< float >::cross3 ( const Vec4< float > & vector )

inherited

Calculate the cross product between this vector and an other vector (not taking into account the w ordinate).

Operates in the native datatype

Parameters

vector Second vector used to perform the calculation.

Returns: reference to this object

float clan::Vec4< float >::distance3 ( const Vec4< float > & vector ) const

inherited

Calculate the distance between this vector and an other vector (not taking into account the w ordinate).

Parameters

vector = Second vector used to calculate distance.

Returns: The distance between the two vectors.

float clan::Vec4< float >::distance4 ( const Vec4< float > & vector ) const

inherited

Calculate the distance between this vector and an other vector (taking into account the w ordinate).

Parameters

vector = Second vector used to calculate distance.

Returns: The distance between the two vectors.

static float clan::Vec4< float >::dot3	(	const Vec4< float > &	vector1,
		const Vec4< float > &	vector2
	)

inlinestaticinherited

Dot products between two vectors (not taking into account the w ordinate).

Operates in the native datatype

Parameters

vector1	First vector used for the dot product.
vector2	Second vector used for the dot product.

Returns: The resulting dot product of the two vectors.

float clan::Vec4< float >::dot3 ( const Vec4< float > & vector ) const

inlineinherited

Dot products this vector with an other vector (not taking into account the w ordinate).

Operates in the native datatype

Parameters

vector Second vector used for the dot product.

Returns: The resulting dot product of the two vectors.

References clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

static float clan::Vec4< float >::dot4	(	const Vec4< float > &	vector1,
		const Vec4< float > &	vector2
	)

inlinestaticinherited

Dot products between two vectors (taking into account the w ordinate).

Operates in the native datatype

Parameters

vector1	First vector used for the dot product.
vector2	Second vector used for the dot product.

Returns: The resulting dot product of the two vectors.

float clan::Vec4< float >::dot4 ( const Vec4< float > & vector ) const

inlineinherited

Dot products this vector with an other vector (taking into account the w ordinate).

Operates in the native datatype

Parameters

vector Second vector used for the dot product.

Returns: The resulting dot product of the two vectors.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

static bool clan::Vec4< float >::is_equal	(	const Vec4< float > &	first,
		const Vec4< float > &	second,
		float	epsilon
	)

inlinestaticinherited

Returns true if equal within the bounds of an epsilon.

Parameters

first	= Value A
second	= Value B
epsilon	= The epsilon (eg FLT_EPSILON/2, DBL_EPSILON/2)

bool clan::Vec4< float >::is_equal	(	const Vec4< float > &	other,
		float	epsilon
	)		const

inlineinherited

Returns true if equal within the bounds of an epsilon.

Parameters

other	= Other value
epsilon	= The epsilon (eg FLT_EPSILON/2, DBL_EPSILON/2)

References clan::Vec4< Type >::is_equal().

* float clan::Vec4< float >::length3 ( ) const

inherited

Returns the length (magnitude) of this vector (not taking into account the w ordinate).

Operates in the native datatype

Returns: the length of the vector

* float clan::Vec4< float >::length4 ( ) const

inherited

Returns the length (magnitude) of this vector (taking into account the w ordinate).

Operates in the native datatype

Returns: the length of the vector

static Vec4<float > clan::Vec4< float >::normalize3 ( const Vec4< float > & vector )

staticinherited

Normalizes a vector (not taking into account the w ordinate)

Operates in the native datatype

Parameters

vector = The vector to use

Returns: the normalized vector

Vec4<float >& clan::Vec4< float >::normalize3 ( )

inherited

Normalizes this vector (not taking into account the w ordinate)

Operates in the native datatype

Returns: reference to this object

static Vec4<float > clan::Vec4< float >::normalize4 ( const Vec4< float > & vector )

staticinherited

Normalizes a vector (taking into account the w ordinate)

Operates in the native datatype

Parameters

vector = The vector to use

Returns: the normalized vector

Vec4<float >& clan::Vec4< float >::normalize4 ( )

inherited

Normalizes this vector (taking into account the w ordinate)

Operates in the native datatype

Returns: reference to this object

bool clan::Vec4< float >::operator!= ( const Vec4< float > & vector ) const

inlineinherited

!= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator*= ( const Vec4< float > & vector )

inlineinherited

*= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator*= ( float value )

inlineinherited

*= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator+= ( const Vec4< float > & vector )

inlineinherited

+= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator+= ( float value )

inlineinherited

+= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

Vec4<float > clan::Vec4< float >::operator- ( ) const

inlineinherited

operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator-= ( const Vec4< float > & vector )

inlineinherited

-= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator-= ( float value )

inlineinherited

-= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator/= ( const Vec4< float > & vector )

inlineinherited

/= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

void clan::Vec4< float >::operator/= ( float value )

inlineinherited

/= operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

bool clan::Vec4< float >::operator< ( const Vec4< float > & vector ) const

inlineinherited

< operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

bool clan::Vec4< float >::operator== ( const Vec4< float > & vector ) const

inlineinherited

== operator.

References clan::Vec4< Type >::w, clan::Vec4< Type >::x, clan::Vec4< Type >::y, and clan::Vec4< Type >::z.

static Vec4<float > clan::Vec4< float >::rotate3	(	const Vec4< float > &	vector,
		const Angle &	angle,
		const Vec4< float > &	axis
	)

staticinherited

Rotate a vector around an axis. Same as glRotate[f|d](angle, a);.

Not taking into account the w ordinate
The w ordinate is not modified

Parameters

vector	= The vector to use
angle	Angle to rotate
axis	Rotation axis.

Returns: The rotated vector

Vec4<float >& clan::Vec4< float >::rotate3	(	const Angle &	angle,
		const Vec4< float > &	axis
	)

inherited

Rotate this vector around an axis. Same as glRotate[f|d](angle, a);.

Not taking into account the w ordinate
The w ordinate is not modified

Parameters

angle	Angle to rotate
axis	Rotation axis.

Returns: reference to this object

static Vec4<float > clan::Vec4< float >::round ( const Vec4< float > & vector )

staticinherited

Rounds all components on a vector.

Includes the w ordinate
Uses Asymmetric Arithmetic Rounding

Parameters

vector = The vector to use

Returns: The rounded vector

Vec4<float >& clan::Vec4< float >::round ( )

inherited

Rounds all components on this vector.

Includes the w ordinate
Uses Asymmetric Arithmetic Rounding

Returns: reference to this object

Member Data Documentation

union { ... }

float clan::Vec4< float >::a

inherited

Referenced by get_alpha(), normalize(), operator!=(), operator==(), and set_alpha().

float clan::Vec4< float >::b

inherited

Referenced by get_blue(), normalize(), operator!=(), operator==(), and set_blue().

float clan::Vec4< float >::g

inherited

Referenced by get_green(), normalize(), operator!=(), operator==(), and set_green().

float clan::Vec4< float >::r

inherited

Referenced by get_red(), normalize(), operator!=(), operator==(), and set_red().

float clan::Vec4< float >::s

inherited

float clan::Vec4< float >::t

inherited

float clan::Vec4< float >::u

inherited

float clan::Vec4< float >::v

inherited

float clan::Vec4< float >::w

inherited

float clan::Vec4< float >::x

inherited

float clan::Vec4< float >::y

inherited

float clan::Vec4< float >::z

inherited

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

color.h

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Member Typedef Documentation

Member Function Documentation

Member Data Documentation