Public Member Functions | Public Attributes | Static Public Attributes | List of all members
iaux::iaColor3< T > Class Template Reference

#include <iaColor3.h>

Public Member Functions

 iaColor3 ()
 
 iaColor3 (T r, T g, T b)
 
void set (T r, T g, T b)
 
T * getData ()
 
iaColor3< T > operator= (const iaColor3< T > &color)
 
void operator+= (const iaColor3< T > &color)
 
void operator-= (const iaColor3< T > &color)
 
void operator*= (float32 factor)
 
void operator* (float32 factor)
 
 iaColor3 ()
 
 iaColor3 ()
 
const iaColor3< float32 > white (1.0, 1.0, 1.0)
 
const iaColor3< uint8 > white (0xff, 0xff, 0xff)
 
const iaColor3< float32 > lightGray (0.75, 0.75, 0.75)
 
const iaColor3< uint8 > lightGray (0xb, 0xbf, 0xbf)
 
const iaColor3< float32 > gray (0.5, 0.5, 0.5)
 
const iaColor3< uint8 > gray (0x80, 0x80, 0x80)
 
const iaColor3< float32 > darkGray (0.25, 0.25, 0.25)
 
const iaColor3< uint8 > darkGray (0x40, 0x40, 0x40)
 
const iaColor3< float32 > black (0.0, 0.0, 0.0)
 
const iaColor3< uint8 > black (0x00, 0x00, 0x00)
 
const iaColor3< float32 > red (1.0, 0.0, 0.0)
 
const iaColor3< uint8 > red (0xff, 0x00, 0x00)
 
const iaColor3< float32 > green (0.0, 1.0, 0.0)
 
const iaColor3< uint8 > green (0x00, 0xff, 0x00)
 
const iaColor3< float32 > blue (0.0, 0.0, 1.0)
 
const iaColor3< uint8 > blue (0x00, 0x00, 0xff)
 
const iaColor3< float32 > yellow (1.0, 1.0, 0.0)
 
const iaColor3< uint8 > yellow (0xff, 0xff, 0x00)
 
const iaColor3< float32 > magenta (1.0, 0.0, 1.0)
 
const iaColor3< uint8 > magenta (0xff, 0x00, 0xff)
 
const iaColor3< float32 > cyan (0.0, 1.0, 1.0)
 
const iaColor3< uint8 > cyan (0x00, 0xff, 0xff)
 

Public Attributes

T _r
 
T _g
 
T _b
 

Static Public Attributes

static IAUX_API_IMPORT_ONLY const iaColor3< T > white
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > lightGray
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > gray
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > darkGray
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > black
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > red
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > green
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > blue
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > yellow
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > cyan
 
static IAUX_API_IMPORT_ONLY const iaColor3< T > magenta
 

Detailed Description

template<class T>
class iaux::iaColor3< T >

3 component color class

for floating point variant we expect values in range from 0.0 - 1.0 for integer variant we expect values in range from 0.0 - 255.0

Constructor & Destructor Documentation

◆ iaColor3() [1/4]

template<class T >
iaux::iaColor3< T >::iaColor3 ( )

ctor initializes members

◆ iaColor3() [2/4]

template<class T >
iaColor3::iaColor3 ( T  r,
T  g,
T  b 
)

ctor initializes members with parameters

Parameters
rred component
ggreen component
bblue component

◆ iaColor3() [3/4]

iaux::iaColor3< float32 >::iaColor3 ( )

◆ iaColor3() [4/4]

iaColor3::iaColor3 ( )

Member Function Documentation

◆ black() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::black ( 0.  0,
0.  0,
0.  0 
)

◆ black() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::black ( 0x00  ,
0x00  ,
0x00   
)

◆ blue() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::blue ( 0.  0,
0.  0,
1.  0 
)

◆ blue() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::blue ( 0x00  ,
0x00  ,
0xff   
)

◆ cyan() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::cyan ( 0.  0,
1.  0,
1.  0 
)

◆ cyan() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::cyan ( 0x00  ,
0xff  ,
0xff   
)

◆ darkGray() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::darkGray ( 0.  25,
0.  25,
0.  25 
)

◆ darkGray() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::darkGray ( 0x40  ,
0x40  ,
0x40   
)

◆ getData()

template<class T >
T * iaColor3::getData ( )
Returns
pointer to data

◆ gray() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::gray ( 0.  5,
0.  5,
0.  5 
)

◆ gray() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::gray ( 0x80  ,
0x80  ,
0x80   
)

◆ green() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::green ( 0.  0,
1.  0,
0.  0 
)

◆ green() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::green ( 0x00  ,
0xff  ,
0x00   
)

◆ lightGray() [1/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::lightGray ( 0.  75,
0.  75,
0.  75 
)

◆ lightGray() [2/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::lightGray ( 0xb  ,
0xbf  ,
0xbf   
)

◆ magenta() [1/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::magenta ( 0xff  ,
0x00  ,
0xff   
)

◆ magenta() [2/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::magenta ( 1.  0,
0.  0,
1.  0 
)

◆ operator*()

template<class T >
void iaux::iaColor3< T >::operator* ( float32  factor)

scale operator

Parameters
factorthe factor to scale with

◆ operator*=()

template<class T >
void iaColor3::operator*= ( float32  factor)

scale operator

Parameters
factorthe factor to scale with

◆ operator+=()

template<class T >
void iaColor3::operator+= ( const iaColor3< T > &  color)

add operator

\parm color the color to add

◆ operator-=()

template<class T >
void iaColor3::operator-= ( const iaColor3< T > &  color)

subtract operator

\parm color the color to subtract

◆ operator=()

template<class T >
iaColor3< T > iaColor3::operator= ( const iaColor3< T > &  color)

assignment operator

\parm color the color to copy

◆ red() [1/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::red ( 0xff  ,
0x00  ,
0x00   
)

◆ red() [2/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::red ( 1.  0,
0.  0,
0.  0 
)

◆ set()

template<class T >
void iaColor3::set ( T  r,
T  g,
T  b 
)

set members

Parameters
rred component
ggreen component
bblue component

◆ white() [1/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::white ( 0xff  ,
0xff  ,
0xff   
)

◆ white() [2/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::white ( 1.  0,
1.  0,
1.  0 
)

◆ yellow() [1/2]

const iaColor3< uint8 > iaux::iaColor3< uint8 >::yellow ( 0xff  ,
0xff  ,
0x00   
)

◆ yellow() [2/2]

const iaColor3< float32 > iaux::iaColor3< float32 >::yellow ( 1.  0,
1.  0,
0.  0 
)

Member Data Documentation

◆ _b

template<class T >
T iaux::iaColor3< T >::_b

blue component

◆ _g

template<class T >
T iaux::iaColor3< T >::_g

green component

◆ _r

template<class T >
T iaux::iaColor3< T >::_r

red component

◆ black

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::black
static

◆ blue

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::blue
static

◆ cyan

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::cyan
static

◆ darkGray

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::darkGray
static

◆ gray

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::gray
static

◆ green

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::green
static

◆ lightGray

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::lightGray
static

◆ magenta

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::magenta
static

◆ red

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::red
static

◆ white

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::white
static

◆ yellow

template<class T >
IAUX_API_IMPORT_ONLY const iaColor3<T> iaux::iaColor3< T >::yellow
static
The documentation for this class was generated from the following files: