Handles the TKE_Termination and TKE_Pause opcodes. More...
#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Execute (BStreamFileToolkit &tk) |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
TK_Terminator (char opcode, bool is_file_terminator=true) | |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. | |
Protected Attributes | |
bool | m_terminate_file |
internal use for hsx read-write only. This indicates if the TKE_Terminate is |
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.
TK_Terminator::TK_Terminator | ( | char | opcode, |
bool | is_file_terminator = true |
||
) | [inline] |
constructor
TK_Status TK_Terminator::Execute | ( | BStreamFileToolkit & | tk | ) | [virtual] |
Processes the binary data that has been read for the current object, which involves passing the data to application-specific data structures.
tk | A reference to the BStreamFileToolkit object. |
Reimplemented from BBaseOpcodeHandler.
TK_Status TK_Terminator::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.
TK_Status TK_Terminator::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.
tk | A reference to the BStreamFileToolkit object. |
Implements BBaseOpcodeHandler.