#include <BOpcodeHandler.h>
Public Member Functions | |
TK_Status | Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const |
ID_Key | GetKey () const |
TK_Status | Read (BStreamFileToolkit &tk) |
TK_Status | ReadAscii (BStreamFileToolkit &tk) |
Deprecated. | |
void | SetKey (ID_Key k) |
TK_Renumber (unsigned char opcode, ID_Key key=0) | |
TK_Status | Write (BStreamFileToolkit &tk) |
TK_Status | WriteAscii (BStreamFileToolkit &tk) |
Deprecated. | |
Protected Attributes | |
ID_Key | m_key |
for internal use only |
TK_Renumber provides support for writing/reading the TKE_Renumber_Key_Global and TKE_Renumber_Key_Local opcode objects to/from an HSF file. This action operates on whatever entity was specified in the previous opcode.
The HOOPS/3dGS scene-graph supports the concept of renumbered keys. (Keys can refer to either segments or geometric primitives.) HOOPS entities that do not have keys (e.g. rendering options and other attributes) may not be renumbered. HOOPS/3DGS segments may hav a priority value assigned which overrides the default alphabetic sorting.
TK_Renumber::TK_Renumber | ( | unsigned char | opcode, | |
ID_Key | key = 0 | |||
) | [inline] |
same as the default constructor in BBaseOpcodeHandler, except that a new key can optionally be provided directly at the time of construction
TK_Status TK_Renumber::Clone | ( | BStreamFileToolkit & | tk, | |
BBaseOpcodeHandler ** | handler | |||
) | const [virtual] |
Copies the opcode handler
tk | A reference to the BStreamFileToolkit object. | |
handler | A pointer to the opcode handler object. Passed by reference. |
Reimplemented from BBaseOpcodeHandler.
ID_Key TK_Renumber::GetKey | ( | ) | const [inline] |
Returns the key (identifier) value
TK_Status TK_Renumber::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_Renumber::SetKey | ( | ID_Key | k | ) | [inline] |
Sets the key (identifier) value
TK_Status TK_Renumber::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.