TK_Conditional_Action

class TK_Conditional_Action

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

Inherits from: BBaseOpcodeHandler

Methods

TK_Conditional_Action::TK_Conditional_Action()

constructor

TK_Conditional_Action::~TK_Conditional_Action()
TK_Status TK_Conditional_Action::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_Conditional_Action::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_Conditional_Action::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_Conditional_Action::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Conditional_Action::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

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

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

void TK_Conditional_Action::SetCondition(int length)

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

char const *TK_Conditional_Action::GetCondition() const

const

Returns the conditions string.

char *TK_Conditional_Action::GetCondition()

Returns the conditions string buffer, which may be modified directly

int TK_Conditional_Action::GetLength()

Returns the size of the string buffer (number of chars, not including any space for trailing null)

void TK_Conditional_Action::SetAction(int at)

Sets the action type.

int TK_Conditional_Action::GetAction() const

const

Returns the action type.

void TK_Conditional_Action::SetOptions(int at)

Sets the options flags.

int TK_Conditional_Action::GetOptions() const

const

Returns the options flags.

Variables

short TK_Conditional_Action::m_type

protected

short

Action type

short TK_Conditional_Action::m_options

protected

short

Option flags

int TK_Conditional_Action::m_length

protected

int

Length of text string

char *TK_Conditional_Action::m_string

protected

char

Text string