TK_Callback Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Callback:

Inheritance graph
[legend]
Collaboration diagram for TK_Callback:

Collaboration graph
[legend]
List of all members.

Detailed Description

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

Definition at line 2537 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

int m_length
char * m_string


Constructor & Destructor Documentation

TK_Callback::TK_Callback  )  [inline]
 

constructor

Definition at line 2553 of file BOpcodeHandler.h.


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.

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

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

Definition at line 2572 of file BOpcodeHandler.h.

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

Returns the callback string.

Definition at line 2570 of file BOpcodeHandler.h.

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 void   )  [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

Definition at line 2568 of file BOpcodeHandler.h.

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

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

Definition at line 2566 of file BOpcodeHandler.h.

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

Definition at line 2543 of file BOpcodeHandler.h.

char* TK_Callback::m_string [protected]
 

Text string

Definition at line 2544 of file BOpcodeHandler.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 6 22:41:41 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5