HTK_Referenced_Segment

class HTK_Referenced_Segment

Provides HOOPS/3dGS-specific handling of the TKE_Reopen_Segment opcodes.

This class complements the read/write functionality implemented in the base class by overloading the Interpret and Execute methods to provide HOOPS/3dGS-specific opcode handling.

Writing: The HOOPS/3dGS database is queried in the Interpret method, and this data is then written to the HSF file by the Write method Reading: The data is read from the HSF file by the Read method, and is mapped to the HOOPS/3dGS scene-graph within the Execute method.

Export/import of additional user-data (which is associated with this HSF object) would typically be done by overloading the Write and Read methods.

Inherits from: TK_Referenced_Segment

Methods

HTK_Referenced_Segment::HTK_Referenced_Segment(char opcode)

constructor

TK_Status HTK_Referenced_Segment::Write(BStreamFileToolkit &tk)
TK_Status HTK_Referenced_Segment::Execute(BStreamFileToolkit &tk)
TK_Status HTK_Referenced_Segment::Interpret(BStreamFileToolkit &tk, ID_Key key, int variant = 0)
TK_Status HTK_Referenced_Segment::Interpret(BStreamFileToolkit &tk, ID_Key key, char const *special)
void HTK_Referenced_Segment::Reset()
TK_Status HTK_Referenced_Segment::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

const

void HTK_Referenced_Segment::SetRoot(HC_KEY root)

Records the top of a segment tree in order to determine whether referenced segment can be a relative reference

Parameters

root: Key of segment at top of tree
HC_KEY HTK_Referenced_Segment::GetRoot() const

const

Returns

the key of the root segment (see SetRoot)

Variables

int HTK_Referenced_Segment::mh_stage

protected

int

create a class-specific ‘stage’ var to avoid confusion with base class ‘stage’ variable

HC_KEY HTK_Referenced_Segment::m_root

protected

HC_KEY

root of current tree, to see if referenced can be relative