# TK_Unicode_Options

## Functions

| `TK_Unicode_Options`
| `~TK_Unicode_Options`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetOptions`
void | `SetOptions`
unsigned short const * | `GetOptions`
unsigned short * | `GetOptions`
int | `GetLength`

## Detailed Description

class TK_Unicode_Options : public BBaseOpcodeHandler

  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.

  Public Functions

  inline TK_Unicode_Options()

    constructor

  ~TK_Unicode_Options()
  virtual TK_Status Read(BStreamFileToolkit &tk)

    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.

  virtual TK_Status Write(BStreamFileToolkit &tk)

    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.

  virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

    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.

  TK_Status ReadAscii(BStreamFileToolkit &tk)

    Deprecated.

  TK_Status WriteAscii(BStreamFileToolkit &tk)

    Deprecated.

  virtual void Reset()

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

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

  void SetOptions(int length)

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

  inline unsigned short const *GetOptions() const

    Returns the user options string.

  inline unsigned short *GetOptions()

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

  inline int GetLength()

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