TK_Callback

Detailed Description

class TK_Callback : public BBaseOpcodeHandler

Handles the TKE_Callback opcode.

TK_Callback provides support for writing/reading the TKE_Callback opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph can store callback requests (functions triggered at certain points during drawing or selection of a scene).

Subclassed by HTK_Callback

Public Functions

inline TK_Callback()

constructor

~TK_Callback()
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 SetCallback(char const *callback)

Sets the callback string. Allocates the buffer and copies the specified string

inline void SetCallback(int length)

Sets the callback string buffer. Allocates a buffer which will hold a string of ‘length’ characters

inline char const *GetCallback() const

Returns the callback string.

inline char *GetCallback()

Returns the callback string buffer, which may be modified directly.