Main Page | Modules | Namespace List | Class Hierarchy | Class List | Directories | File List | Namespace Members | Class Members | File Members | Related Pages
Emma::Color

Emma::Color Class Reference

Color contains functions to create color values and a set of color contants. More...

#include <EmmaColor.h>

Inheritance diagram for Emma::Color:

Fusion::Object Fusion::IObject List of all members.

Public Member Functions

 Color ()
 DECLARE_CLASS (Color, Object)
virtual int getIndex (lua_State *l)
float _RGB (int32_t r, int32_t g, int32_t b)
 Return a 32 bit value representing the passed RGB color Value contains the ARGB values at 4 8 bit values from 0 to 255.
float _RGBA (int32_t r, int32_t g, int32_t b, int32_t a)
 This function behaves the same as RGB, except that alpha is set to the passed value rather than 255.
float fRGB (float r, float g, float b)
 This function behaves the same as RGB except that the values are floating point, between 0 and 1.
float fRGBA (float r, float g, float b, float a)
 This function behaves the same as fRGB except that the alpha is set to the passed value rather than 255.
float sRGB (const Fusion::UTF8String &s)
 This function converts the passed string into a 32 bit integer representing a color value.
float sRGBA (const Fusion::UTF8String &s)
 This function behaves the same as sRGB, except that the upper 8 bits are left unmodified, allowing an alpha value to be included.

Protected Member Functions

virtual ~Color ()

Detailed Description

Color contains functions to create color values and a set of color contants.

Remarks:
Base class Object
Author:
Chris Marrin
Date:
7/13/2005

Constructor & Destructor Documentation

virtual Emma::Color::~Color (   )  [inline, protected, virtual]
 

Emma::Color::Color (   )  [inline]
 

Member Function Documentation

float Emma::Color::_RGB (  int32_t  r,
int32_t  g,
int32_t  b
)  [inline]
 

Return a 32 bit value representing the passed RGB color Value contains the ARGB values at 4 8 bit values from 0 to 255.

Returns a float which gives a value color when placed in a MFFloat array (for instance, the vertex field of Mesh). Alpha is set to 255.

float Emma::Color::_RGBA (  int32_t  r,
int32_t  g,
int32_t  b,
int32_t  a
)  [inline]
 

This function behaves the same as RGB, except that alpha is set to the passed value rather than 255.

Emma::Color::DECLARE_CLASS (  Color  ,
Object 
) 
 

float Emma::Color::fRGB (  float  r,
float  g,
float  b
)  [inline]
 

This function behaves the same as RGB except that the values are floating point, between 0 and 1.

float Emma::Color::fRGBA (  float  r,
float  g,
float  b,
float  a
)  [inline]
 

This function behaves the same as fRGB except that the alpha is set to the passed value rather than 255.

virtual int Emma::Color::getIndex (  lua_State *  l  )  [virtual]
 

Reimplemented from Fusion::Object.

float Emma::Color::sRGB (  const Fusion::UTF8String &  s  ) 
 

This function converts the passed string into a 32 bit integer representing a color value.

The string can be in any of the numeric format supported in the Emma file format. The upper 8 bits of the number are set to 0xff, representing an alpha value of 255. Returns a float which gives a value color when placed in a MFFloat array (for instance, the vertex field of Mesh). Alpha is set to 255.

float Emma::Color::sRGBA (  const Fusion::UTF8String &  s  ) 
 

This function behaves the same as sRGB, except that the upper 8 bits are left unmodified, allowing an alpha value to be included.

The documentation for this class was generated from the following file:
Generated on Sat Apr 1 06:08:21 2006 for Emma SDK Guide by  doxygen 1.4.3