Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Terminator Class Reference

Handles the TKE_Termination and TKE_Pause opcodes. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Terminator:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Execute (BStreamFileToolkit &tk) alter
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
 TK_Terminator (char opcode, bool is_file_terminator=true)
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

bool m_terminate_file
 internal use for hsx read-write only. This indicates if the TKE_Terminate is


Detailed Description

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.


Constructor & Destructor Documentation

TK_Terminator::TK_Terminator ( char  opcode,
bool  is_file_terminator = true 
) [inline]

constructor


Member Function Documentation

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.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

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.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

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.

Parameters:
tk A reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: