HTK_Shell

Functions

TK_Status

Execute

TK_Status

Interpret

TK_Status

Interpret

TK_Status

Clone

bool

Match_Instance

Detailed Description

class HTK_Shell : public TK_Shell

Provides HOOPS/3dGS-specific handling of the TKE_Shell opcode.

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.

Public Functions

virtual TK_Status Execute(BStreamFileToolkit &tk)

Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.

Parameters

tk – A reference to the BStreamFileToolkit object.

Returns

The result of the function call.

TK_Status Interpret(BStreamFileToolkit &tk, ID_Key key, int variant = -1)
inline TK_Status Interpret(BStreamFileToolkit &tk, ID_Key key, char const *special)
virtual TK_Status Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.

virtual bool Match_Instance(BStreamFileToolkit const &tk, Recorded_Instance *instance)

Determines whether a stored instance of an object is compatible with the current object, and if it is, prepares the object to write the instance instead.