Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Attributes
TK_Color_By_Index Class Reference

Handles the TKE_Color_By_Index and TKE_Color_By_Index_16 opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetGeometry () const
int GetIndex () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetGeometry (int m)
void SetIndex (int i)
 TK_Color_By_Index (unsigned char opcode)
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_index
 internal use
int m_mask
 internal use

Detailed Description

Handles the TKE_Color_By_Index and TKE_Color_By_Index_16 opcode.

TK_Color_By_Index provides support for writing/reading the TKE_Color_By_Index and TKE_Color_By_Index_16 opcode objects to/from an HSF file. (The first being an 8-bit index, the second being a 16-bit index)

The HOOPS/3dGS scene-graph segments can have colors set by index into a colormap


Constructor & Destructor Documentation

TK_Color_By_Index::TK_Color_By_Index ( unsigned char  opcode) [inline]

constructor


Member Function Documentation

TK_Status TK_Color_By_Index::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.

int TK_Color_By_Index::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_Index::GetIndex ( ) const [inline]

Returns the color value as an index into the effective color map

TK_Status TK_Color_By_Index::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_Index::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_Index::SetIndex ( int  i) [inline]

Sets the color value as an index into the effective color map

TK_Status TK_Color_By_Index::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: