karto::Color Class Reference

#include <Geometry.h>

List of all members.

Public Member Functions
	Color ()
	Color (const Color &rOther)
	Color (kt_double red, kt_double green, kt_double blue, kt_double alpha=1.0)
	Color (kt_int8u red, kt_int8u green, kt_int8u blue, kt_int8u alpha=255)
const kt_double	GetAlpha () const
const kt_double	GetBlue () const
const kt_double	GetGreen () const
const kt_double	GetRed () const
kt_bool	operator!= (const Color &rOther) const
kt_bool	operator== (const Color &rOther) const
void	SetAlpha (kt_double alpha)
void	SetBlue (kt_double blue)
void	SetGreen (kt_double green)
void	SetRed (kt_double red)
const String	ToString () const
virtual	~Color ()
Private Attributes
kt_double	m_Alpha
kt_double	m_Blue
kt_double	m_Green
kt_double	m_Red
Friends
KARTO_FORCEINLINE std::ostream &	operator<< (std::ostream &rStream, const Color &rColor)

---

Detailed Description

Definition at line 2846 of file Geometry.h.

---

Constructor & Destructor Documentation

karto::Color::Color

(

)

[inline]

Black color

Definition at line 2852 of file Geometry.h.

karto::Color::Color

(

const Color &

rOther

)

[inline]

Copy constructor

Definition at line 2863 of file Geometry.h.

karto::Color::Color	(	kt_double	red,
		kt_double	green,
		kt_double	blue,
		kt_double	alpha = 1.0
	)		[inline]

Color with given RGBA values

Parameters:

red	red
green	green
blue	blue
alpha	alpha

Definition at line 2878 of file Geometry.h.

karto::Color::Color	(	kt_int8u	red,
		kt_int8u	green,
		kt_int8u	blue,
		kt_int8u	alpha = 255
	)		[inline]

Color with given RGBA values

Parameters:

red
green
blue
alpha

Definition at line 2893 of file Geometry.h.

virtual karto::Color::~Color

(

)

[inline, virtual]

Destructor

Definition at line 2904 of file Geometry.h.

---

Member Function Documentation

const kt_double karto::Color::GetAlpha

(

)

const [inline]

Alpha value of this color

Returns:

alpha value

Definition at line 2967 of file Geometry.h.

const kt_double karto::Color::GetBlue

(

)

const [inline]

Blue component of this color

Returns:

blue component

Definition at line 2949 of file Geometry.h.

const kt_double karto::Color::GetGreen

(

)

const [inline]

Green component of this color

Returns:

green component

Definition at line 2931 of file Geometry.h.

const kt_double karto::Color::GetRed

(

)

const [inline]

Red component of this color

Returns:

red component

Definition at line 2913 of file Geometry.h.

kt_bool karto::Color::operator!=

(

const Color &

rOther

)

const [inline]

Inequality operator

Definition at line 3010 of file Geometry.h.

kt_bool karto::Color::operator==

(

const Color &

rOther

)

const [inline]

Equality operator

Definition at line 3002 of file Geometry.h.

void karto::Color::SetAlpha

(

kt_double

alpha

)

[inline]

Set the alpha value of this color param alpha alpha value

Definition at line 2976 of file Geometry.h.

void karto::Color::SetBlue

(

kt_double

blue

)

[inline]

Set the blue component of this color param blue blue component

Definition at line 2958 of file Geometry.h.

void karto::Color::SetGreen

(

kt_double

green

)

[inline]

Set the green component of this color param green green component

Definition at line 2940 of file Geometry.h.

void karto::Color::SetRed

(

kt_double

red

)

[inline]

Set the red component of this color param red red component

Definition at line 2922 of file Geometry.h.

const String karto::Color::ToString

(

)

const [inline]

Returns a string representation of this color

Returns:

string representation of this color

Definition at line 2985 of file Geometry.h.

---

Friends And Related Function Documentation

KARTO_FORCEINLINE std::ostream& operator<<	(	std::ostream &	rStream,
		const Color &	rColor
	)		[friend]

Write color onto output stream

Definition at line 3018 of file Geometry.h.

---

Member Data Documentation

kt_double karto::Color::m_Alpha [private]

Definition at line 3028 of file Geometry.h.

kt_double karto::Color::m_Blue [private]

Definition at line 3027 of file Geometry.h.

kt_double karto::Color::m_Green [private]

Definition at line 3026 of file Geometry.h.

kt_double karto::Color::m_Red [private]

Definition at line 3025 of file Geometry.h.

---

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

• Geometry.h