TK_User_Options Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_User_Options:

Inheritance graph
[legend]
Collaboration diagram for TK_User_Options:

Collaboration graph
[legend]
List of all members.

Detailed Description

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.

Definition at line 4784 of file BOpcodeHandler.h.

Public Member Functions

 TK_User_Options ()
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 SetOptions (char const *options) alter
void SetOptions (int length) alter
char const * GetOptions (void) const
char alter * GetOptions (void) alter
int GetLength (void) alter

Protected Member Functions

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

Protected Attributes

int m_length
char * m_string
BBaseOpcodeHandlerm_indices
BBaseOpcodeHandlerm_unicode


Constructor & Destructor Documentation

TK_User_Options::TK_User_Options  )  [inline]
 

constructor

Definition at line 4800 of file BOpcodeHandler.h.


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

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

Definition at line 4822 of file BOpcodeHandler.h.

char alter* TK_User_Options::GetOptions void   )  [inline]
 

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

Definition at line 4820 of file BOpcodeHandler.h.

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

Returns the user options string.

Definition at line 4818 of file BOpcodeHandler.h.

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 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_Options::SetOptions int  length  )  [inline]
 

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

Definition at line 4816 of file BOpcodeHandler.h.

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

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

Definition at line 4814 of file BOpcodeHandler.h.

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

BBaseOpcodeHandler* TK_User_Options::m_indices [protected]
 

Index handler

Definition at line 4792 of file BOpcodeHandler.h.

int TK_User_Options::m_length [protected]
 

Length of text string

Definition at line 4790 of file BOpcodeHandler.h.

char* TK_User_Options::m_string [protected]
 

Text string

Definition at line 4791 of file BOpcodeHandler.h.

BBaseOpcodeHandler* TK_User_Options::m_unicode [protected]
 

Unicode handler

Definition at line 4793 of file BOpcodeHandler.h.


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