TK_Conditions

class TK_Conditions

Handles the TKE_Conditions opcode.

TK_Conditions provides support for writing/reading the TKE_Conditions opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports conditional use of style & include segments. A condition is simply a string containing a comma-separated list of condition flags being turned on or off

Inherits from: BBaseOpcodeHandler

Methods

TK_Conditions::TK_Conditions()

constructor

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

Deprecated.

TK_Status TK_Conditions::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Conditions::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_Conditions::SetConditions(char const *options)

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

void TK_Conditions::SetConditions(int length)

Sets the conditions string buffer. Allocates a buffer which can hold a srting of ‘length’ characters

char const *TK_Conditions::GetConditions() const

const

Returns the conditions string.

char *TK_Conditions::GetConditions()

Returns the conditions string buffer, which may be modified directly

int TK_Conditions::GetLength()

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

Variables

int TK_Conditions::m_length

protected

int

Length of text string

char *TK_Conditions::m_string

protected

char

Text string