TK_Color_By_Index Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Color_By_Index:

Inheritance graph
[legend]
Collaboration diagram for TK_Color_By_Index:

Collaboration graph
[legend]
List of all members.

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

Definition at line 2335 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Attributes

int m_mask
 internal use
int m_index
 internal use


Constructor & Destructor Documentation

TK_Color_By_Index::TK_Color_By_Index unsigned char  opcode  )  [inline]
 

constructor

Definition at line 2346 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Color_By_Index::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_Index::GetGeometry void   )  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.

Definition at line 2374 of file BOpcodeHandler.h.

int TK_Color_By_Index::GetIndex void   )  const [inline]
 

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

Definition at line 2379 of file BOpcodeHandler.h.

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:
tk A 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.

Definition at line 2359 of file BOpcodeHandler.h.

void TK_Color_By_Index::SetIndex int  i  )  [inline]
 

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

Definition at line 2377 of file BOpcodeHandler.h.

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:
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:
Generated on Tue Jan 6 22:41:41 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5