TK_User_Index Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_User_Index:

Inheritance graph
[legend]
Collaboration diagram for TK_User_Index:

Collaboration graph
[legend]
List of all members.

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.

Definition at line 4875 of file BOpcodeHandler.h.

Public Member Functions

 TK_User_Index ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void Reset (void) alter
void SetIndices (int count, int const *indices, long const *values) alter
void SetIndices (int count) alter
int GetCount (void) const
int const * GetIndices (void) const
int alter * GetIndices (void) alter
long const * GetValues (void) const
long alter * GetValues (void) alter

Protected Member Functions

void set_indices (int count, int const *indices, long const *values) alter
 for internal use only
void set_indices (int count) alter
 for internal use only

Protected Attributes

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


Constructor & Destructor Documentation

TK_User_Index::TK_User_Index  )  [inline]
 

constructor

Definition at line 4890 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_User_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_User_Index::GetCount void   )  const [inline]
 

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

Definition at line 4909 of file BOpcodeHandler.h.

int alter* TK_User_Index::GetIndices void   )  [inline]
 

Returns the index array buffer, which may be modified directly

Definition at line 4913 of file BOpcodeHandler.h.

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

Returns the index array

Definition at line 4911 of file BOpcodeHandler.h.

long alter* TK_User_Index::GetValues void   )  [inline]
 

Returns the value array buffer, which may be modified directly

Definition at line 4917 of file BOpcodeHandler.h.

long const* TK_User_Index::GetValues void   )  const [inline]
 

Returns the value array

Definition at line 4915 of file BOpcodeHandler.h.

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

Implements BBaseOpcodeHandler.

void TK_User_Index::Reset void   )  [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  )  [inline]
 

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

Definition at line 4907 of file BOpcodeHandler.h.

void TK_User_Index::SetIndices int  count,
int const *  indices,
long const *  values
[inline]
 

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

Definition at line 4904 of file BOpcodeHandler.h.

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:
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:48 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5