TK_Reference

class TK_Reference

Handles the TKE_Reference opcodes.

TK_Reference provides support for writing/reading the TKE_Reference opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph nodes are called ‘segments’ which store, geometry, attributes, and subsegments. The scene-graph provides support for referencing an individual geometry item, or all geometry items, from another segment as if they were within the current segment, without the attributes or additional subsegments that would be brought along with an ‘include’.

Inherits from: BBaseOpcodeHandler

Methods

TK_Reference::TK_Reference()

constructor

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

Deprecated.

TK_Status TK_Reference::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Reference::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_Reference::SetIndex(int index)

Sets the id of the referenced item

ID_Key TK_Reference::GetIndex()

Returns the id of the referenced item

void TK_Reference::SetCondition(char const *condition)

Set the condition string. Makes sure the buffer is big enough to hold the condition, and copies it in

void TK_Reference::SetCondition(int length)

Set the condition string. Makes sure the buffer is big enough to hold a string of ‘length’ characters

char const *TK_Reference::GetCondition() const

const

Get the condition string. Returns a pointer to the current condition

char *TK_Reference::GetCondition()

Get the condition string buffer. Returns a pointer to the current condition buffer which may then be modified directly

void TK_Reference::SetFollow(bool f)

Sets the flag indicating whether the referenced item should be processed itself

bool TK_Reference::GetFollow()

Returns the flag indicating whether the referenced item should be processed itself

Variables

int TK_Reference::m_index

protected

int

tag index of referenced item. for internal use only

int TK_Reference::m_cond_length

protected

int

Length of condition. for internal use only

int TK_Reference::m_cond_allocated

protected

int

Size of currently available condition buffer. for internal use only

char *TK_Reference::m_condition

protected

char

Condition. for internal use only

ID_Key TK_Reference::m_this_key

protected

for internal use only

ID_Key TK_Reference::m_key

protected

for internal use only

BBaseOpcodeHandler *TK_Reference::m_referee

protected

for internal use only

bool TK_Reference::m_follow

protected

bool

for internal use only