TK_User_Index_Data

class TK_User_Index_Data

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.

Inherits from: BBaseOpcodeHandler

Methods

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

protected

for internal use only

void TK_User_Index_Data::set_indices(int count)

protected

for internal use only

void TK_User_Index_Data::FreeMem()

protected

TK_User_Index_Data::TK_User_Index_Data()

constructor

TK_User_Index_Data::~TK_User_Index_Data()
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.
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.
TK_Status TK_User_Index_Data::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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

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

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

void TK_User_Index_Data::SetIndices(int count)

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

int TK_User_Index_Data::GetCount() const

const

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

int const *TK_User_Index_Data::GetIndices() const

const

Returns the index array

int *TK_User_Index_Data::GetIndices()

Returns the index array buffer, which may be modified directly

void **TK_User_Index_Data::GetValues() const

const

Returns the value array

void **TK_User_Index_Data::GetValues()

Returns the value array buffer, which may be modified directly

int const *TK_User_Index_Data::GetSizes() const

const

Returns the sizes array

int *TK_User_Index_Data::GetSizes()

Returns the sizes array buffer, which may be modified directly

Variables

int TK_User_Index_Data::m_count

protected

int

for internal use only

int *TK_User_Index_Data::m_indices

protected

int

for internal use only

void **TK_User_Index_Data::m_values

protected

void

for internal use only

int *TK_User_Index_Data::m_sizes

protected

int
int TK_User_Index_Data::m_current_value

protected

int

for internal use only