AaronCameron.net
I care not for your petty politics.
Not a Member? - Login or Create an Account
Sunday the 5th of February 2012 @ 05:01pm
Front Page Journal Projects Your Profile About
[]

LibN2L-4 Library Code Reference

Classes
Compounds
Files
Members
Method Index
Full Reference

n2l::cColour Class Reference

A representation of a colour which may or may not have an alpha channel. More...

#include <cColour.h>

Collaboration diagram for n2l::cColour:

Collaboration graph
[legend]
List of all members.

Public Member Functions

Static Public Attributes


Detailed Description

A representation of a colour which may or may not have an alpha channel.

Definition at line 38 of file cColour.h.


Constructor & Destructor Documentation

n2l::cColour::cColour  )  [inline]
 

Definition at line 48 of file cColour.h.

n2l::cColour::cColour const cColour iColour  )  [inline]
 

Definition at line 57 of file cColour.h.

References mC.

n2l::cColour::cColour const cDynVar iDef  )  [inline]
 

Definition at line 66 of file cColour.h.

References n2l::cDynVar::keyValueOr().

n2l::cColour::cColour const tFloat iR,
const tFloat iG,
const tFloat iB,
const tFloat iA = 1.0f
[inline]
 

Definition at line 75 of file cColour.h.


Member Function Documentation

const tFloat& n2l::cColour::a  )  const [inline]
 

Definition at line 138 of file cColour.h.

void n2l::cColour::a const tFloat iA  )  [inline]
 

Definition at line 92 of file cColour.h.

Referenced by n2l::cGuiSEColourTrans::actOn(), n2l::cGuiTextStyle::prop(), and n2l::cGuiFill::prop().

const tFloat& n2l::cColour::b  )  const [inline]
 

Definition at line 135 of file cColour.h.

void n2l::cColour::b const tFloat iB  )  [inline]
 

Definition at line 89 of file cColour.h.

Referenced by n2l::cGuiSEColourTrans::actOn(), n2l::cGuiTextStyle::prop(), and n2l::cGuiFill::prop().

void n2l::cColour::clampToZeroOne  )  [inline]
 

Definition at line 223 of file cColour.h.

References n2l::n2lMax(), and n2l::n2lMin().

const tString n2l::cColour::dump  )  const [inline]
 

Definition at line 232 of file cColour.h.

References n2l::asString().

const tFloat& n2l::cColour::g  )  const [inline]
 

Definition at line 132 of file cColour.h.

void n2l::cColour::g const tFloat iG  )  [inline]
 

Definition at line 86 of file cColour.h.

Referenced by n2l::cGuiSEColourTrans::actOn(), n2l::cGuiTextStyle::prop(), and n2l::cGuiFill::prop().

void n2l::cColour::get tFloat oR,
tFloat oG,
tFloat oB,
tFloat oA
const [inline]
 

Definition at line 147 of file cColour.h.

void n2l::cColour::get tFloat oR,
tFloat oG,
tFloat oB
const [inline]
 

Definition at line 141 of file cColour.h.

void n2l::cColour::glColor3f  )  const [inline]
 

Definition at line 257 of file cColour.h.

void n2l::cColour::glColor3fv  )  const [inline]
 

Definition at line 254 of file cColour.h.

Referenced by glColour3().

void n2l::cColour::glColor4f  )  const [inline]
 

Definition at line 249 of file cColour.h.

void n2l::cColour::glColor4fv  )  const [inline]
 

Definition at line 246 of file cColour.h.

Referenced by n2l::cParticle::draw(), and glColour4().

void n2l::cColour::glColour3  )  const [inline]
 

Definition at line 260 of file cColour.h.

References glColor3fv().

void n2l::cColour::glColour4  )  const [inline]
 

Definition at line 263 of file cColour.h.

References glColor4fv().

Referenced by n2l::cGuiTextStyle::draw(), and n2l::cGuiFill::draw().

void n2l::cColour::glLightfv const GLenum  iLight,
const GLenum  iProp
const [inline]
 

Definition at line 272 of file cColour.h.

void n2l::cColour::glMaterialfv const GLenum  iFace,
const GLenum  iPName
const [inline]
 

Definition at line 266 of file cColour.h.

Referenced by n2l::cMaterial::useMaterial().

void n2l::cColour::normalize  )  [inline]
 

I have no idea if this is correct, but after combining colours, we need to bring the magnitude of each of the components to under 1.0.

Since I have no idea how to do this correctly. I'm going to make something up. Enjoy.

Definition at line 109 of file cColour.h.

const cColour n2l::cColour::operator * const tFloat iScaler  )  const [inline]
 

Definition at line 187 of file cColour.h.

void n2l::cColour::operator *= const tFloat iScaler  )  [inline]
 

Definition at line 195 of file cColour.h.

void n2l::cColour::operator *= const cColour iColour  )  [inline]
 

Definition at line 162 of file cColour.h.

References mC.

const cColour n2l::cColour::operator+ const cColour iColour  )  const [inline]
 

Definition at line 179 of file cColour.h.

References mC.

void n2l::cColour::operator+= const cColour iColour  )  [inline]
 

Definition at line 153 of file cColour.h.

References mC.

const cColour n2l::cColour::operator- const cColour iColour  )  const [inline]
 

Definition at line 171 of file cColour.h.

References mC.

void n2l::cColour::operator-= const cColour iColour  )  [inline]
 

Definition at line 204 of file cColour.h.

References mC.

cColour& n2l::cColour::operator= const cDynVar iDef  )  [inline]
 

Definition at line 213 of file cColour.h.

References n2l::cDynVar::keyValueOr().

const tFloat& n2l::cColour::r  )  const [inline]
 

Definition at line 129 of file cColour.h.

void n2l::cColour::r const tFloat iR  )  [inline]
 

Definition at line 83 of file cColour.h.

Referenced by n2l::cGuiSEColourTrans::actOn(), n2l::cGuiTextStyle::prop(), and n2l::cGuiFill::prop().

cColour& n2l::cColour::set const tFloat iR,
const tFloat iG,
const tFloat iB,
const tFloat iA = 1.0f
[inline]
 

Definition at line 95 of file cColour.h.

Referenced by n2l::cMaterial::load(), and n2l::cMaterial::setGLDefault().


Member Data Documentation

const cColour n2l::cColour::Black [static]
 

Definition at line 45 of file cColour.h.

const cColour n2l::cColour::Blue [static]
 

Definition at line 43 of file cColour.h.

const cColour n2l::cColour::Green [static]
 

Definition at line 44 of file cColour.h.

const cColour n2l::cColour::Red [static]
 

Definition at line 42 of file cColour.h.

const cColour n2l::cColour::White [static]
 

Definition at line 41 of file cColour.h.


The documentation for this class was generated from the following files:
©2012 Aaron Cameron