# TK_Font

## Functions

| `TK_Font`
| `~TK_Font`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetType`
int | `GetType`
void | `SetBytes`
int | `GetBytesCount`
char const * | `GetBytes`
char * | `GetBytes`
void | `SetName`
void | `SetName`
char const * | `GetName`
char * | `GetName`
void | `SetLookup`
void | `SetLookup`
char const * | `GetLookup`
char * | `GetLookup`
void | `SetEncoding`
int | `GetEncoding`

## Detailed Description

class `TK_Font` : public BBaseOpcodeHandler

  Handles the TKE_Font opcode.

  TK_Font provides support for writing/reading the TKE_Font opcode object to/from an HSF file.

  The HOOPS/3dGS scene-graph supports user-defined fonts. Refer to the function ::HC_Define_Font in the HOOPS/3dGS Reference Manual

  Subclassed by HTK_Font

  Public Functions

  inline `TK_Font`()

    constructor

  `~TK_Font`()
  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.

  inline void `SetType`(int t)

    Set the type of the font (HOOPS stroked font definition is the only one supported so far)

  inline int `GetType`() const

    Returns the type of the font

  inline void `SetBytes`(int size, char const *bytes = 0)

    Sets the font data. Allocates a buffer which can hold ‘size’ bytes, and if specified, copies the data from ‘bytes’ to the buffer

  inline int `GetBytesCount`() const

    Returns the size of the data buffer

  inline char const *`GetBytes`() const

    Returns the address of the data buffer

  inline char *`GetBytes`()

    Returns the address of the data buffer, which may be modified directly

  inline void `SetName`(char const *string)

    Sets the name of the font. Allocates the buffer and copies the string

  inline void `SetName`(int length)

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

  inline char const *`GetName`() const

    Returns the font name string

  inline char *`GetName`()

    Returns the font name string buffer, which may be modified directly

  inline void `SetLookup`(char const *string)

    Sets the name of the lookup function. Allocates the buffer and copies the string

  inline void `SetLookup`(int length)

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

  inline char const *`GetLookup`() const

    Returns the lookup function name string

  inline char *`GetLookup`()

    Returns the lookup name string buffer, which may be modified directly

  inline void `SetEncoding`(int e)

    Set the type of encoding for this font

  inline int `GetEncoding`() const

    Returns the type of encoding for this font

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your multilingual generative AI assistant for documentation. Ask me anything about HOOPS Visualize 3DF in your own language, or choose a sample question below to start a conversation:

What is HOOPS Visualize 3DF?
What are the latest release notes for HOOPS Visualize 3DF?
How do I start evaluating HOOPS Visualize 3DF?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...