TK_User_Options

class TK_User_Options

Handles the TKE_User_Options opcode.

TK_User_Options provides support for writing/reading the TKE_User_Options opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports storing non-graphical data per segment. A user-option is simply a string containing a comma-separated set of string pairs.

Inherits from: BBaseOpcodeHandler

Methods

void TK_User_Options::set_options(char const *options)

protected

for internal use only

void TK_User_Options::set_options(int length)

protected

for internal use only

TK_User_Options::TK_User_Options()

constructor

TK_User_Options::~TK_User_Options()
TK_Status TK_User_Options::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_Options::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_Options::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.
TK_Status TK_User_Options::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_User_Options::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_User_Options::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_Options::SetOptions(char const *options)

Sets the user options string. Allocates the buffer and copies the string

void TK_User_Options::SetOptions(int length)

Sets the user options string buffer. Allocates a buffer which can hold a srting of ‘length’ characters

char const *TK_User_Options::GetOptions() const

const

Returns the user options string.

char *TK_User_Options::GetOptions()

Returns the user options string buffer, which may be modified directly

int TK_User_Options::GetLength()

Returns the size of the string buffer (number of chars, not including any space for trailing null)

Variables

int TK_User_Options::m_length

protected

int

Length of text string

char *TK_User_Options::m_string

protected

char

Text string

BBaseOpcodeHandler *TK_User_Options::m_indices

protected

Index handler

BBaseOpcodeHandler *TK_User_Options::m_unicode

protected

Unicode handler

BBaseOpcodeHandler *TK_User_Options::m_index_data

protected

User Data handler