# TK_Conditions

## Functions

| `TK_Conditions`
| `~TK_Conditions`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetConditions`
void | `SetConditions`
char const * | `GetConditions`
char * | `GetConditions`
int | `GetLength`

## Detailed Description

class `TK_Conditions` : public BBaseOpcodeHandler

  Handles the TKE_Conditions opcode.

  TK_Conditions provides support for writing/reading the TKE_Conditions opcode object to/from an HSF file.

  The HOOPS/3dGS scene-graph supports conditional use of style & include segments. A condition is simply a string containing a comma-separated list of condition flags being turned on or off

  Subclassed by HTK_Conditions

  Public Functions

  inline `TK_Conditions`()

    constructor

  `~TK_Conditions`()
  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 `SetConditions`(char const *options)

    Sets the conditions string. Allocates the buffer and copies the string

  void `SetConditions`(int length)

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

  inline char const *`GetConditions`() const

    Returns the conditions string.

  inline char *`GetConditions`()

    Returns the conditions string buffer, which may be modified directly

  inline int `GetLength`()

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

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...