#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Execute (BStreamFileToolkit &tk) alter |
int | GetFlags () alter |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) alter |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, int variant) alter |
TK_Status | Read (BStreamFileToolkit &tk) alter |
TK_Status | ReadAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
void | SetFlags (int f) alter |
TK_File_Info () | |
TK_Status | Write (BStreamFileToolkit &tk) alter |
TK_Status | WriteAscii (BStreamFileToolkit &tk) alter |
Deprecated. | |
Protected Attributes | |
int | m_flags |
internal use |
TK_File_Info provides support for writing/reading the TKE_File_Info opcode object to/from an HSF file.
The TKE_File_Info opcode object contains information about how the file was written.
TK_File_Info::TK_File_Info | ( | ) | [inline] |
constructor
TK_Status TK_File_Info::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.
int TK_File_Info::GetFlags | ( | void | ) | [inline] |
Returns the flag indicating whether the reference segment should be processed itself
TK_Status TK_File_Info::Interpret | ( | BStreamFileToolkit & | tk, | |
ID_Key | key, | |||
char const * | special | |||
) | [inline, virtual] |
Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.
tk | A reference to the BStreamFileToolkit object. | |
key | An identifier to the object (for example, the HOOPS key of a geometry item) | |
special | A string value of particular data |
Reimplemented from BBaseOpcodeHandler.
References BBaseOpcodeHandler::Interpret().
TK_Status TK_File_Info::Interpret | ( | BStreamFileToolkit & | tk, | |
ID_Key | key, | |||
int | variant | |||
) | [virtual] |
Extracts graphics data (typically from the application's scene-graph) and maps it to the opcode handler's data members in preparation for writing out an object to the file.
tk | A reference to the BStreamFileToolkit object. | |
key | An identifier to the object (for example, the HOOPS key of a geometry item) | |
variant | optional specification of an alternate form, such as a Level-of-Detail representation |
Reimplemented from BBaseOpcodeHandler.
TK_Status TK_File_Info::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.
void TK_File_Info::SetFlags | ( | int | f | ) | [inline] |
Sets the flag indicating whether the reference segment should be processed itself
TK_Status TK_File_Info::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.