Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_User_Options Class Reference

Handles the TKE_User_Options opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_User_Options:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetLength ()
char * GetOptions ()
char const * GetOptions () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void Reset ()
void SetOptions (int length)
void SetOptions (char const *options)
 TK_User_Options ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Member Functions

void set_options (int length)
 for internal use only
void set_options (char const *options)
 for internal use only

Protected Attributes

BBaseOpcodeHandlerm_index_data
BBaseOpcodeHandlerm_indices
int m_length
char * m_string
BBaseOpcodeHandlerm_unicode


Detailed Description

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.


Constructor & Destructor Documentation

TK_User_Options::TK_User_Options (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_User_Options::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_Options::GetLength (  )  [inline]

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

char* TK_User_Options::GetOptions (  )  [inline]

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

char const* TK_User_Options::GetOptions (  )  const [inline]

Returns the user options string.

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.

Implements BBaseOpcodeHandler.

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.

Reimplemented from BBaseOpcodeHandler.

void TK_User_Options::SetOptions ( int  length  )  [inline]

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

void TK_User_Options::SetOptions ( char const *  options  )  [inline]

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

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.

Implements BBaseOpcodeHandler.


Member Data Documentation

User Data handler

Index handler

int TK_User_Options::m_length [protected]

Length of text string

char* TK_User_Options::m_string [protected]

Text string

Unicode handler


The documentation for this class was generated from the following file: