Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Color_By_Value Class Reference

Handles the TKE_Color_By_Value opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetGeometry () const
int GetSpace () const
float const * GetValue () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void SetGeometry (int m) alter
void SetSpace (int s) alter
void SetValue (float a, float b, float c) alter
void SetValue (float const *triple) alter
 TK_Color_By_Value ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_mask
 internal use
char m_space
 internal use
float m_value [3]
 internal use

Detailed Description

Handles the TKE_Color_By_Value opcode.

TK_Color_By_Value provides support for writing/reading the TKE_Color_By_Value opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph segments can have colors set by value (RGB, HSV, HIC, etc...)


Constructor & Destructor Documentation

TK_Color_By_Value::TK_Color_By_Value ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_Color_By_Value::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Color_By_Value.

int TK_Color_By_Value::GetGeometry ( ) const [inline]

Returns the mask value which indicates which types of geometry are affected by this color setting. Geometry types are specified by TKO_Geometry_Bits.

int TK_Color_By_Value::GetSpace ( ) const [inline]

Returns the type of color space used to interpret the values

float const* TK_Color_By_Value::GetValue ( ) const [inline]

Returns the color value as the address of a float triplet

TK_Status TK_Color_By_Value::Read ( BStreamFileToolkit tk) [virtual]

Reads data from the toolkit buffer, decodes/decompresses it, and maps it to the opcode handlers data members. User-defined classes which need to write out custom data should utilize one of the available GetData() methods.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Color_By_Value::SetGeometry ( int  m) [inline]

Sets the mask value which indicates which types of geometry are affected by this color setting. Geometry types are specified by TKO_Geometry_Bits.

References TKO_Geo_All_Colors, TKO_Geo_Extended, TKO_Geo_Extended2, TKO_Geo_Extended2_Mask, TKO_Geo_Extended_Colors, TKO_Geo_Extended_Colors_Mask, and TKO_Geo_Extended_Mask.

void TK_Color_By_Value::SetSpace ( int  s) [inline]

Sets the type of color space used to interpret the values

void TK_Color_By_Value::SetValue ( float  a,
float  b,
float  c 
) [inline]

Sets the color value as discrete floats

void TK_Color_By_Value::SetValue ( float const *  triple) [inline]

Sets the color value as a float triplet

References SetValue().

Referenced by SetValue().

TK_Status TK_Color_By_Value::Write ( BStreamFileToolkit tk) [virtual]

Encodes/compresses data and writes data to the toolkit buffer. User-defined classes which need to write out custom data should utilize one of the available PutData() methods, and first write out the opcode associated with the group of binary data followed by the data itself.

Parameters:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: