Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Color_By_FIndex Class Reference

Handles the TKE_Color_By_FIndex opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Color_By_FIndex:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetGeometry () const
float GetIndex () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void SetGeometry (int m) alter
void SetIndex (float val) alter
 TK_Color_By_FIndex ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

float m_index
 internal use
int m_mask
 internal use


Detailed Description

Handles the TKE_Color_By_FIndex opcode.

TK_Color_By_FIndex provides support for writing/reading the TKE_Color_By_FIndex opcode object to/from an HSF file.

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


Constructor & Destructor Documentation

TK_Color_By_FIndex::TK_Color_By_FIndex (  )  [inline]

constructor


Member Function Documentation

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

Copies the opcode handler

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

Reimplemented from BBaseOpcodeHandler.

int TK_Color_By_FIndex::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.

float TK_Color_By_FIndex::GetIndex (  )  const [inline]

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

TK_Status TK_Color_By_FIndex::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:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Color_By_FIndex::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_FIndex::SetIndex ( float  val  )  [inline]

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

TK_Status TK_Color_By_FIndex::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:
tk A 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: