Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages

CEGUI::colour Class Reference

Class representing colour values within the system. More...

#include <CEGUIcolour.h>

List of all members.

Public Member Functions

 colour (void)
 colour (const colour &val)
 colour (float red, float green, float blue, float alpha=1.0f)
 colour (argb_t argb)
argb_t getARGB (void) const
float getAlpha (void) const
float getRed (void) const
float getGreen (void) const
float getBlue (void) const
float getHue (void) const
float getSaturation (void) const
float getLumination (void) const
void setARGB (argb_t argb)
void setAlpha (float alpha)
void setRed (float red)
void setGreen (float green)
void setBlue (float blue)
void set (float red, float green, float blue, float alpha=1.0f)
void setRGB (float red, float green, float blue)
void setRGB (const colour &val)
void setHSL (float hue, float saturation, float luminance, float alpha=1.0f)
void invertColour (void)
void invertColourWithAlpha (void)
colouroperator= (argb_t val)
colouroperator= (const colour &val)
colouroperator &= (argb_t val)
colouroperator &= (const colour &val)
colouroperator|= (argb_t val)
colouroperator|= (const colour &val)
colouroperator<<= (int val)
colouroperator>>= (int val)
colour operator+ (const colour &val) const
colour operator- (const colour &val) const
colour operator * (const float val) const
colouroperator *= (const colour &val)
bool operator== (const colour &rhs) const
bool operator!= (const colour &rhs) const
 operator argb_t () const


Detailed Description

Class representing colour values within the system.

Definition at line 41 of file CEGUIcolour.h.


Constructor & Destructor Documentation

CEGUI::colour::colour void   ) 
 

Definition at line 36 of file CEGUIcolour.cpp.

CEGUI::colour::colour const colour val  ) 
 

Definition at line 47 of file CEGUIcolour.cpp.

References operator=().

CEGUI::colour::colour float  red,
float  green,
float  blue,
float  alpha = 1.0f
 

Definition at line 53 of file CEGUIcolour.cpp.

CEGUI::colour::colour argb_t  argb  ) 
 

Definition at line 63 of file CEGUIcolour.cpp.

References setARGB().


Member Function Documentation

float CEGUI::colour::getAlpha void   )  const [inline]
 

Definition at line 66 of file CEGUIcolour.h.

Referenced by CEGUI::MultiLineEditbox::cacheTextLines(), CEGUI::Static::calculateModulatedAlphaColour(), CEGUI::ListboxItem::calculateModulatedAlphaColour(), and CEGUI::ColourRect::modulateAlpha().

argb_t CEGUI::colour::getARGB void   )  const [inline]
 

Definition at line 55 of file CEGUIcolour.h.

Referenced by CEGUI::DirectX81Renderer::addQuad(), CEGUI::DirectX9Renderer::addQuad(), CEGUI::PropertyHelper::colourRectToString(), CEGUI::PropertyHelper::colourToString(), operator &=(), operator|=(), and CEGUI::ImagerySection::render().

float CEGUI::colour::getBlue void   )  const [inline]
 

Definition at line 69 of file CEGUIcolour.h.

float CEGUI::colour::getGreen void   )  const [inline]
 

Definition at line 68 of file CEGUIcolour.h.

float CEGUI::colour::getHue void   )  const
 

Definition at line 69 of file CEGUIcolour.cpp.

References ceguimax, and ceguimin.

float CEGUI::colour::getLumination void   )  const
 

Definition at line 132 of file CEGUIcolour.cpp.

References ceguimax, and ceguimin.

float CEGUI::colour::getRed void   )  const [inline]
 

Definition at line 67 of file CEGUIcolour.h.

float CEGUI::colour::getSaturation void   )  const
 

Definition at line 108 of file CEGUIcolour.cpp.

References ceguimax, and ceguimin.

void CEGUI::colour::invertColour void   ) 
 

Definition at line 243 of file CEGUIcolour.cpp.

void CEGUI::colour::invertColourWithAlpha void   ) 
 

Definition at line 251 of file CEGUIcolour.cpp.

colour& CEGUI::colour::operator &= const colour val  )  [inline]
 

Definition at line 166 of file CEGUIcolour.h.

References getARGB().

colour& CEGUI::colour::operator &= argb_t  val  )  [inline]
 

Definition at line 160 of file CEGUIcolour.h.

colour CEGUI::colour::operator * const float  val  )  const [inline]
 

Definition at line 216 of file CEGUIcolour.h.

colour& CEGUI::colour::operator *= const colour val  )  [inline]
 

Definition at line 226 of file CEGUIcolour.h.

References d_alpha, d_blue, d_green, and d_red.

CEGUI::colour::operator argb_t  )  const [inline]
 

Definition at line 257 of file CEGUIcolour.h.

bool CEGUI::colour::operator!= const colour rhs  )  const [inline]
 

Definition at line 249 of file CEGUIcolour.h.

colour CEGUI::colour::operator+ const colour val  )  const [inline]
 

Definition at line 196 of file CEGUIcolour.h.

References d_alpha, d_blue, d_green, and d_red.

colour CEGUI::colour::operator- const colour val  )  const [inline]
 

Definition at line 206 of file CEGUIcolour.h.

References d_alpha, d_blue, d_green, and d_red.

colour& CEGUI::colour::operator<<= int  val  )  [inline]
 

Definition at line 184 of file CEGUIcolour.h.

colour& CEGUI::colour::operator= const colour val  )  [inline]
 

Definition at line 148 of file CEGUIcolour.h.

References d_alpha, d_argb, d_argbValid, d_blue, d_green, and d_red.

colour& CEGUI::colour::operator= argb_t  val  )  [inline]
 

Definition at line 142 of file CEGUIcolour.h.

Referenced by colour().

bool CEGUI::colour::operator== const colour rhs  )  const [inline]
 

Definition at line 241 of file CEGUIcolour.h.

References d_alpha, d_blue, d_green, and d_red.

colour& CEGUI::colour::operator>>= int  val  )  [inline]
 

Definition at line 190 of file CEGUIcolour.h.

colour& CEGUI::colour::operator|= const colour val  )  [inline]
 

Definition at line 178 of file CEGUIcolour.h.

References getARGB().

colour& CEGUI::colour::operator|= argb_t  val  )  [inline]
 

Definition at line 172 of file CEGUIcolour.h.

void CEGUI::colour::set float  red,
float  green,
float  blue,
float  alpha = 1.0f
[inline]
 

Definition at line 104 of file CEGUIcolour.h.

void CEGUI::colour::setAlpha float  alpha  )  [inline]
 

Definition at line 80 of file CEGUIcolour.h.

Referenced by CEGUI::MultiLineEditbox::cacheTextLines(), CEGUI::Static::calculateModulatedAlphaColour(), CEGUI::ListboxItem::calculateModulatedAlphaColour(), CEGUI::ColourRect::modulateAlpha(), CEGUI::ColourRect::setAlpha(), CEGUI::ColourRect::setBottomAlpha(), CEGUI::ColourRect::setLeftAlpha(), CEGUI::ColourRect::setRightAlpha(), and CEGUI::ColourRect::setTopAlpha().

void CEGUI::colour::setARGB argb_t  argb  ) 
 

Definition at line 142 of file CEGUIcolour.cpp.

Referenced by colour().

void CEGUI::colour::setBlue float  blue  )  [inline]
 

Definition at line 98 of file CEGUIcolour.h.

void CEGUI::colour::setGreen float  green  )  [inline]
 

Definition at line 92 of file CEGUIcolour.h.

void CEGUI::colour::setHSL float  hue,
float  saturation,
float  luminance,
float  alpha = 1.0f
 

Definition at line 158 of file CEGUIcolour.cpp.

void CEGUI::colour::setRed float  red  )  [inline]
 

Definition at line 86 of file CEGUIcolour.h.

void CEGUI::colour::setRGB const colour val  )  [inline]
 

Definition at line 121 of file CEGUIcolour.h.

References d_argb, d_argbValid, d_blue, d_green, and d_red.

void CEGUI::colour::setRGB float  red,
float  green,
float  blue
[inline]
 

Definition at line 113 of file CEGUIcolour.h.


The documentation for this class was generated from the following files:
Generated on Wed Sep 7 10:05:39 2005 for Crazy Eddies GUI System by  doxygen 1.4.3