Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_User_Index Class Reference

Handles the TKE_User_Index opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetCount () const
int const * GetIndices () const
int * GetIndices ()
HLONG const * GetValues () const
HLONG * GetValues ()
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetIndices (int count, int const indices[], POINTER_SIZED_INT const values[])
void SetIndices (int count)
 TK_User_Index ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Member Functions

void set_indices (int count, int const indices[], POINTER_SIZED_INT const values[])
 for internal use only
void set_indices (int count)
 for internal use only

Protected Attributes

int m_count
 for internal use only
int m_current_value
 for internal use only
int * m_indices
 for internal use only
HLONG * m_values
 for internal use only

Detailed Description

Handles the TKE_User_Index opcode.

TK_User_Index provides support for writing/reading the TKE_User_Index opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports storing non-graphical data per segment. A user-index is an index into a list of user options.


Constructor & Destructor Documentation

TK_User_Index::TK_User_Index ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_User_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.

Reimplemented in HTK_User_Index.

int TK_User_Index::GetCount ( ) const [inline]

Returns the current size of the buffers as the number of index-value pairs they can contain

int const* TK_User_Index::GetIndices ( ) const [inline]

Returns the index array

int* TK_User_Index::GetIndices ( ) [inline]

Returns the index array buffer, which may be modified directly

HLONG const* TK_User_Index::GetValues ( ) const [inline]

Returns the value array

HLONG* TK_User_Index::GetValues ( ) [inline]

Returns the value array buffer, which may be modified directly

TK_Status TK_User_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_User_Index::Reset ( ) [virtual]

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

Reimplemented from BBaseOpcodeHandler.

void TK_User_Index::SetIndices ( int  count,
int const  indices[],
POINTER_SIZED_INT const  values[] 
) [inline]

Sets the index-value pairs. Allocates buffers and copies the indices and values

void TK_User_Index::SetIndices ( int  count) [inline]

Sets the index-value pair buffers. Allocates buffers which can hold 'count' index-value pairs

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