LTI-Lib latest version v1.9 - last update 10 Apr 2010

lti::cmykColor Class Reference

A little class for defining points in the CMYK color space. More...

#include <ltiCMYKColor.h>

List of all members.

Public Member Functions

 cmykColor ()
 cmykColor (float nc, float nm, float ny, float nk)
float getCyan () const
float getMagenta () const
float getYellow () const
float getBlack () const
void setCyan (const float &cyan)
void setMagenta (const float &magenta)
void setYellow (const float &yellow)
void setBlack (const float &black)
cmykColorcopy (const cmykColor &other)
cmykColoroperator= (const cmykColor &other)
bool isEqual (const cmykColor &other) const
bool operator== (const cmykColor &other) const
bool operator!= (const cmykColor &other) const
bool operator< (const cmykColor &other) const
bool operator> (const cmykColor &other) const

Detailed Description

A little class for defining points in the CMYK color space.

At present, CMYK colors can only be used for EPS drawings.


Constructor & Destructor Documentation

lti::cmykColor::cmykColor (  )  [inline]

Default constructor.

Sets this color to (0,0,0,0) which is the CMYK representation of white.

lti::cmykColor::cmykColor ( float  nc,
float  nm,
float  ny,
float  nk 
) [inline]

Constructor.

Sets the C, M, Y, and K components to the given values.


Member Function Documentation

cmykColor& lti::cmykColor::copy ( const cmykColor other  )  [inline]

Copies the "other" color to this color.

Referenced by operator=().

float lti::cmykColor::getBlack (  )  const [inline]

Returns the value of the K (=blacK) component of this color.

Referenced by isEqual(), operator<(), operator>(), and lti::write().

float lti::cmykColor::getCyan (  )  const [inline]

Returns the value of the C (=Cyan) component of this color.

Referenced by isEqual(), operator<(), operator>(), and lti::write().

float lti::cmykColor::getMagenta (  )  const [inline]

Returns the value of the M (=Magenta) component of this color.

Referenced by isEqual(), operator<(), operator>(), and lti::write().

float lti::cmykColor::getYellow (  )  const [inline]

Returns the value of the Y (=Yellow) component of this color.

Referenced by isEqual(), operator<(), operator>(), and lti::write().

bool lti::cmykColor::isEqual ( const cmykColor other  )  const [inline]

Compare two colors (true if equal!).

References getBlack(), getCyan(), getMagenta(), and getYellow().

Referenced by operator!=(), and operator==().

bool lti::cmykColor::operator!= ( const cmykColor other  )  const [inline]

Alias for !compare().

References isEqual().

bool lti::cmykColor::operator< ( const cmykColor other  )  const [inline]

An cmykColor is said to be "smaller" than another one, if any of its component values is smaller than the other component.

References getBlack(), getCyan(), getMagenta(), and getYellow().

cmykColor& lti::cmykColor::operator= ( const cmykColor other  )  [inline]

Alias for copy.

References copy().

bool lti::cmykColor::operator== ( const cmykColor other  )  const [inline]

Alias for compare().

References isEqual().

bool lti::cmykColor::operator> ( const cmykColor other  )  const [inline]

An cmykColor is said to be "bigger" than another one, if any of its component values is smaller than the other component.

References getBlack(), getCyan(), getMagenta(), and getYellow().

void lti::cmykColor::setBlack ( const float &  black  )  [inline]

sets the value of the Black component of this color

Referenced by lti::read().

void lti::cmykColor::setCyan ( const float &  cyan  )  [inline]

sets the value of the Cyan component of this color

Referenced by lti::read().

void lti::cmykColor::setMagenta ( const float &  magenta  )  [inline]

sets the value of the Magenta component of this color

Referenced by lti::read().

void lti::cmykColor::setYellow ( const float &  yellow  )  [inline]

sets the value of the Yellow component of this color

Referenced by lti::read().


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

Generated on Sat Apr 10 15:26:43 2010 for LTI-Lib by Doxygen 1.6.1