# TK_Glyph_Definition

## Functions

| `TK_Glyph_Definition`
| `~TK_Glyph_Definition`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetName`
void | `SetName`
char const * | `GetName`
char * | `GetName`
void | `SetDefinition`
int | `GetDefinitionSize`
char const * | `GetDefinition`
char * | `GetDefinition`

## Detailed Description

class TK_Glyph_Definition : public BBaseOpcodeHandler

  Handles the TKE_Glyph_Definition opcode.

  TK_Glyph_Definition provides support for writing/reading the TKE_Glyph_Definition opcode object to/from an HSF file.

  The HOOPS/3dGS scene-graph supports ‘glyph definitions’, which define how to draw markers and components of line patterns.

  Public Functions

  inline TK_Glyph_Definition()

    constructor

  ~TK_Glyph_Definition()
  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 SetName(char const *name)

    Sets the glyph name. Allocates the buffer and copies the name string

  void SetName(int length)

    Sets the glyph name buffer. Allocates a buffer large enough to hold a string of ‘length’ characters

  inline char const *GetName() const

    Returns the glyph name

  inline char *GetName()

    Returns the glyph name buffer, which can be modified directly

  void SetDefinition(int size, char const *data = 0)

    Sets the definition. Allocates the buffer and copies the data if provided

  inline int GetDefinitionSize() const

    Returns the definition size

  inline char const *GetDefinition() const

    Returns the definition buffer

  inline char *GetDefinition()

    Returns the definition buffer, which can be modified directly