TK_Terminator

Detailed Description

class TK_Terminator : public BBaseOpcodeHandler

Handles the TKE_Termination and TKE_Pause opcodes.

TK_Terminator provides support for writing/reading the TKE_Termination and TKE_Pause opcode object to/from an HSF file.

The TKE_Termination opcode object denotes the end of the HSF file. The TKE_Pause opcode is used to signal the end of the main scene-graph objects, which might then be followed by LOD representations of objects.

Public Functions

inline TK_Terminator(char opcode, bool is_file_terminator = true)

constructor

virtual TK_Status Read(BStreamFileToolkit &tk)

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.
virtual TK_Status Write(BStreamFileToolkit &tk)

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.
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 ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status WriteAscii(BStreamFileToolkit &tk)

Deprecated.