Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Callback Class Reference

Handles the TKE_Callback opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Callback:

BBaseOpcodeHandler BControlledMemoryObject HTK_Callback

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
char alter * GetCallback () alter
char const * GetCallback () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void Reset () alter
void SetCallback (int length) alter
void SetCallback (char const *callback) alter
 TK_Callback ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Member Functions

void set_callback (int length) alter
 internal use
void set_callback (char const *callback) alter
 internal use

Protected Attributes

int m_length
char * m_string


Detailed Description

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


Constructor & Destructor Documentation

TK_Callback::TK_Callback (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_Callback::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

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.

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Callback.

char alter* TK_Callback::GetCallback (  )  [inline]

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

char const* TK_Callback::GetCallback (  )  const [inline]

Returns the callback string.

TK_Status TK_Callback::Read ( BStreamFileToolkit tk  )  [virtual]

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.

Implements BBaseOpcodeHandler.

void TK_Callback::Reset (  )  [virtual]

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.

Reimplemented from BBaseOpcodeHandler.

void TK_Callback::SetCallback ( int  length  )  [inline]

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

void TK_Callback::SetCallback ( char const *  callback  )  [inline]

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

TK_Status TK_Callback::Write ( BStreamFileToolkit tk  )  [virtual]

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.

Implements BBaseOpcodeHandler.


Member Data Documentation

int TK_Callback::m_length [protected]

Length of text string

char* TK_Callback::m_string [protected]

Text string


The documentation for this class was generated from the following file: