Structure representing an RGB triple. More...

#include <Color.h>

Public Member Functions
	Color (const unsigned int rgb, unsigned char alpha=255)

	Color (unsigned char red, unsigned char green, unsigned char blue, unsigned char alpha=255)

	Color (unsigned char gray, unsigned char alpha=255)

	Color (const bool valid=true)

void	red (unsigned char red)

void	green (unsigned char green)

void	blue (unsigned char blue)

void	alpha (unsigned char alpha)

unsigned char	red () const

unsigned char	green () const

unsigned char	blue () const

unsigned char	alpha () const

Color &	setRGBi (const unsigned char red, const unsigned char green, const unsigned char blue, const unsigned char alpha=255)

Color &	setRGBf (float red, float green, float blue, float alpha=1.0)

bool	operator== (const Color &other) const

bool	operator!= (const Color &other) const

bool	operator< (const Color &other) const

void	flushPostscript (std::ostream &) const

std::string	svg () const

std::string	svgAlpha (const char *prefix) const

std::string	postscript () const

std::string	tikz () const

bool	valid () const

Static Public Attributes
static const Color	Null

static const Color	Black

static const Color	Gray

static const Color	White

static const Color	Red

static const Color	Green

static const Color	Lime

static const Color	Blue

static const Color	Cyan

static const Color	Magenta

static const Color	Yellow

static const Color	Silver

static const Color	Purple

static const Color	Navy

static const Color	Aqua

Detailed Description

Structure representing an RGB triple.

Color structure.

Examples:: examples/arithmetic.cpp, examples/arrows.cpp, examples/clipping.cpp, examples/ellipse.cpp, examples/example1.cpp, examples/example3.cpp, examples/example4.cpp, and examples/graph.cpp.

Member Function Documentation

string LibBoard::Color::svgAlpha ( const char * prefix ) const

Return a an SVG parameter string for the opacity value.

Parameters

prefix A prefix string to be appended to the returned string if not empty.

Returns: An empty string if alpha == 255, otherwise the string <prefix>-opacity="<alpha-value>".

Referenced by LibBoard::Arrow::flushSVG(), LibBoard::Text::flushSVG(), and LibBoard::Shape::svgProperties().

string LibBoard::Color::tikz ( ) const

Return a string representation of the color usable in TikZ commands. Use the corresponding named color (or a mixture of a named color and black) for predefined colors. Use a mixture of red, green and blue for general colors.

Returns: a string representation of the color usable in TikZ commands.

Referenced by LibBoard::Shape::tikzProperties().

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

include/board/Color.h
src/Color.cpp

Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation