#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
int | GetLength () alter |
char alter * | GetOptions () alter |
char const * | GetOptions () const |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | Reset () alter |
void | SetOptions (int length) alter |
void | SetOptions (char const *options) alter |
TK_User_Options () | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Member Functions | |
void | set_options (int length) alter |
for internal use only | |
void | set_options (char const *options) alter |
for internal use only | |
Protected Attributes | |
BBaseOpcodeHandler * | m_index_data |
BBaseOpcodeHandler * | m_indices |
int | m_length |
char * | m_string |
BBaseOpcodeHandler * | m_unicode |
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.
TK_User_Options::TK_User_Options | ( | ) | [inline] |
constructor
TK_Status TK_User_Options::Clone | ( | BStreamFileToolkit & | tk, | |
BBaseOpcodeHandler ** | handler | |||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. | |
handler | A pointer to the opcode handler object. Passed by reference. |
Reimplemented from BBaseOpcodeHandler.
Reimplemented in HTK_User_Options.
int TK_User_Options::GetLength | ( | ) | [inline] |
Returns the size of the string buffer (number of chars, not including any space for trailing null)
char alter* 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.
tk | A reference to the BStreamFileToolkit object. |
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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
BBaseOpcodeHandler* TK_User_Options::m_index_data [protected] |
User Data handler
BBaseOpcodeHandler* TK_User_Options::m_indices [protected] |
Index handler
int TK_User_Options::m_length [protected] |
Length of text string
char* TK_User_Options::m_string [protected] |
Text string
BBaseOpcodeHandler* TK_User_Options::m_unicode [protected] |
Unicode handler