#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Execute (BStreamFileToolkit &tk) |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, char const *special) |
TK_Status | Interpret (BStreamFileToolkit &tk, ID_Key key, int variant=0) |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
TK_Tag (unsigned char opcode=TKE_Tag) | |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. |
Tags are a means of instructing the toolkit that an object should be 'recorded' during file import and/or export. Things that may be revisited later for refinement should be tagged. See the Programming Guide for more detailed information.
TK_Tag::TK_Tag | ( | unsigned char | opcode = TKE_Tag |
) | [inline] |
constructor
TK_Status TK_Tag::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_Tag::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_Tag::Interpret | ( | BStreamFileToolkit & | tk, | |
ID_Key | key, | |||
int | variant = 0 | |||
) | [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_Tag::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_Tag::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.