Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Attributes
TK_Unicode_Options Class Reference

Handles the TKE_Unicode_Options opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

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

Protected Attributes

int m_length
unsigned short * m_string

Detailed Description

Handles the TKE_Unicode_Options opcode.

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

The HOOPS/3dGS scene-graph supports storing non-graphical data per segment. A unicode-option is simply a wide character (2-bytes per character) string containing a comma-separated set of string pairs.


Constructor & Destructor Documentation

TK_Unicode_Options::TK_Unicode_Options ( ) [inline]

constructor


Member Function Documentation

TK_Status TK_Unicode_Options::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tkA reference to the BStreamFileToolkit object.
handlerA pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

int TK_Unicode_Options::GetLength ( ) [inline]

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

unsigned short const* TK_Unicode_Options::GetOptions ( ) const [inline]

Returns the user options string.

unsigned short* TK_Unicode_Options::GetOptions ( ) [inline]

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

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

Implements BBaseOpcodeHandler.

void TK_Unicode_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_Unicode_Options::SetOptions ( unsigned short const *  options)

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

void TK_Unicode_Options::SetOptions ( int  length)

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

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

Implements BBaseOpcodeHandler.


Member Data Documentation

Length of text string

unsigned short* TK_Unicode_Options::m_string [protected]

Text string


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