TK_Callback

class TK_Callback

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

Inherits from: BBaseOpcodeHandler

Methods

void TK_Callback::set_callback(char const *callback)

protected

internal use

void TK_Callback::set_callback(int length)

protected

internal use

TK_Callback::TK_Callback()

constructor

TK_Callback::~TK_Callback()
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.
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.
TK_Status TK_Callback::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Callback::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Callback::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

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.

void TK_Callback::SetCallback(char const *callback)

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

void TK_Callback::SetCallback(int length)

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

char const *TK_Callback::GetCallback() const

const

Returns the callback string.

char *TK_Callback::GetCallback()

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

Variables

int TK_Callback::m_length

protected

int

Length of text string

char *TK_Callback::m_string

protected

char

Text string