# TK_Conditional_Action

## Functions

| `TK_Conditional_Action`
| `~TK_Conditional_Action`
`TK_Status` | `Read`
`TK_Status` | `Write`
`TK_Status` | `Clone`
`TK_Status` | `ReadAscii`
`TK_Status` | `WriteAscii`
void | `Reset`
void | `SetCondition`
void | `SetCondition`
char const * | `GetCondition`
char * | `GetCondition`
int | `GetLength`
void | `SetAction`
int | `GetAction`
void | `SetOptions`
int | `GetOptions`

## Detailed Description

class TK_Conditional_Action : public BBaseOpcodeHandler

  Handles the TKE_Conditional_Action opcode.

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

  The HOOPS/3dGS scene-graph supports specific actions which can be triggered when specified conditions are present

  Public Functions

  inline TK_Conditional_Action()

    constructor

  ~TK_Conditional_Action()
  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 SetCondition(char const *options)

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

  void SetCondition(int length)

    Sets the condition string buffer. Allocates a buffer which can hold a steing of ‘length’ characters

  inline char const *GetCondition() const

    Returns the conditions string.

  inline char *GetCondition()

    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)

  inline void SetAction(int at)

    Sets the action type.

  inline int GetAction() const

    Returns the action type.

  inline void SetOptions(int at)

    Sets the options flags.

  inline int GetOptions() const

    Returns the options flags.