TK_Unicode_Options
-
class
TK_Unicode_Options Handles the TKE_Unicode_Options opcode.
TK_User_Optionsprovides 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.
Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Unicode_Options::TK_Unicode_Options() constructor
-
TK_Unicode_Options::~TK_Unicode_Options()
-
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
tk: A reference to theBStreamFileToolkitobject.Returns
The result of the function call.
-
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
tk: A reference to theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Unicode_Options::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_Unicode_Options::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Unicode_Options::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
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.
-
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
-
unsigned short const *
TK_Unicode_Options::GetOptions() const const
Returns the user options string.
-
unsigned short *
TK_Unicode_Options::GetOptions() Returns the user options string buffer, which may be modified directly
-
int
TK_Unicode_Options::GetLength() Returns the size of the string buffer (number of shorts, not including any space for trailing null)
Variables
-
int
TK_Unicode_Options::m_length protected
intLength of text string
-
unsigned short *
TK_Unicode_Options::m_string protected
unsigned shortText string