Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_User_Index_Data Class Reference

Handles the TKE_User_Index opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_User_Index_Data:

BBaseOpcodeHandler BControlledMemoryObject HTK_User_Index_Data

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetCount () const
int * GetIndices ()
int const * GetIndices () const
int * GetSizes ()
int const * GetSizes () const
void **const GetValues ()
void **const GetValues () const
TK_Status Read (BStreamFileToolkit &tk)
void Reset ()
void SetIndices (int count)
void SetIndices (int count, int const indices[], void const *values[], int const sizes[])
 TK_User_Index_Data ()
TK_Status Write (BStreamFileToolkit &tk)

Protected Member Functions

void FreeMem ()
void set_indices (int count)
 for internal use only
void set_indices (int count, int const indices[], void const *values[], int const sizes[])
 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
int * m_sizes
void ** 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_Data::TK_User_Index_Data (  )  [inline]

constructor


Member Function Documentation

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

Reimplemented in HTK_User_Index_Data.

int TK_User_Index_Data::GetCount (  )  const [inline]

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

int* TK_User_Index_Data::GetIndices (  )  [inline]

Returns the index array buffer, which may be modified directly

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

Returns the index array

int* TK_User_Index_Data::GetSizes (  )  [inline]

Returns the sizes array buffer, which may be modified directly

int const* TK_User_Index_Data::GetSizes (  )  const [inline]

Returns the sizes array

void** const TK_User_Index_Data::GetValues (  )  [inline]

Returns the value array buffer, which may be modified directly

void** const TK_User_Index_Data::GetValues (  )  const [inline]

Returns the value array

TK_Status TK_User_Index_Data::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_User_Index_Data::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_Data::SetIndices ( int  count  )  [inline]

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

void TK_User_Index_Data::SetIndices ( int  count,
int const   indices[],
void const *  values[],
int const   sizes[] 
) [inline]

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

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