[AE Engine logo] Public API Reference
Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members  

aeColor3 Class Reference

A class representing RGB color. More...

#include <color3.h>

List of all members.

Public Member Functions

 aeColor3 ()
 Create a new color and initialize it to 1.0, 1.0, 1.0 (white).

 aeColor3 (float r, float g, float b)
 Create a new color and initialize it to r, g, b.

void set (float r, float g, float b)
 Set this color to a given RGB value.

void clamp (float r, float g, float b)
 Clamp the color to given RGB values.

void clampDown ()
 Check that color components are not negative.

void add (float r, float g, float b)
 Add given RGB values to this color.

void subtract (float r, float g, float b)
 Subtract given RGB values from this color.

aeColor3 operator= (aeColor3 c)
aeColor3 operator+ (aeColor3 c)
aeColor3 operator- (aeColor3 c)
aeColor3 operator * (float num)

Public Attributes

float red
 The red component of this color.

float green
 The green component of this color.

float blue
 The blue component of this color.


Detailed Description

A class representing RGB color.

Definition at line 33 of file color3.h.


Constructor & Destructor Documentation

aeColor3::aeColor3  
 

Create a new color and initialize it to 1.0, 1.0, 1.0 (white).

aeColor3::aeColor3 float    r,
float    g,
float    b
 

Create a new color and initialize it to r, g, b.

Parameters:
r Red.
g Green.
b Blue.


Member Function Documentation

void aeColor3::add float    r,
float    g,
float    b
 

Add given RGB values to this color.

Parameters:
r Red
g Green
b Blue

void aeColor3::clamp float    r,
float    g,
float    b
 

Clamp the color to given RGB values.

Parameters:
r Red.
g Green.
b Blue.

void aeColor3::clampDown  
 

Check that color components are not negative.

void aeColor3::set float    r,
float    g,
float    b
 

Set this color to a given RGB value.

Parameters:
r Red.
g Green.
b Blue.

void aeColor3::subtract float    r,
float    g,
float    b
 

Subtract given RGB values from this color.

Parameters:
r Red.
g Green.
b Blue.


The documentation for this class was generated from the following file:
AE Engine Public API Reference
Generated on Wed Apr 9 09:43:40 2003 by Doxygen.