geomtools::color::context Struct Reference

Color context object. More...

#include <bayeux/geomtools/color.h>

Public Types
enum	encoding_type { ENCODING_NONE = 0, ENCODING_BY_CODE = 1, ENCODING_BY_VALUE = 2, ENCODING_BY_NAME = 3 }

Public Member Functions
	context ()
	Constructor. More...
void	reset ()
	Reset. More...
bool	is_activated () const
	Check activation status. More...
void	deactivate ()
	Deactivate. More...
bool	encoded_by_code () const
	Check if color is encoded by code. More...
void	set_color_code (color::code_type)
	Set the color code. More...
color::code_type	get_color_code () const
	Return the color code. More...
bool	encoded_by_value () const
	Check if color is encoded by value. More...
void	set_color_value (double)
	Set the color value. More...
double	get_color_value () const
	Return the color value. More...
bool	encoded_by_name () const
	Check if color is encoded by name. More...
void	set_color_name (const std::string &)
	Set the color name. More...
const std::string &	get_color_name () const
	Return the color name. More...
std::string	str () const
	Generate a string. More...

Detailed Description

Color context object.

Member Enumeration Documentation

encoding_type

enum geomtools::color::context::encoding_type

Enumerator
ENCODING_NONE
ENCODING_BY_CODE
ENCODING_BY_VALUE
ENCODING_BY_NAME

Constructor & Destructor Documentation

context()

geomtools::color::context::context

(

)

Constructor.

Member Function Documentation

deactivate()

void geomtools::color::context::deactivate

(

)

Deactivate.

encoded_by_code()

bool geomtools::color::context::encoded_by_code

(

)

const

Check if color is encoded by code.

encoded_by_name()

bool geomtools::color::context::encoded_by_name

(

)

const

Check if color is encoded by name.

encoded_by_value()

bool geomtools::color::context::encoded_by_value

(

)

const

Check if color is encoded by value.

get_color_code()

color::code_type geomtools::color::context::get_color_code

(

)

const

Return the color code.

get_color_name()

const std::string& geomtools::color::context::get_color_name

(

)

const

Return the color name.

get_color_value()

double geomtools::color::context::get_color_value

(

)

const

Return the color value.

is_activated()

bool geomtools::color::context::is_activated

(

)

const

Check activation status.

reset()

void geomtools::color::context::reset

(

)

Reset.

set_color_code()

void geomtools::color::context::set_color_code

(

color::code_type

)

Set the color code.

set_color_name()

void geomtools::color::context::set_color_name

(

const std::string &

)

Set the color name.

set_color_value()

void geomtools::color::context::set_color_value

(

double

)

Set the color value.

str()

std::string geomtools::color::context::str

(

)

const

Generate a string.

---

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

• bayeux/geomtools/color.h