TK_Dictionary
-
class
TK_Dictionary Handles the TKE_Dictionary opcode.
TK_Dictionaryprovides support for writing/reading the TKE_Dictionary opcode object to/from an HSF file.The dictionary provides a mean for locating specific entities in the file. See the Programming Guide for more detailed information.
Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Dictionary::TK_Dictionary() constructor
-
TK_Status
TK_Dictionary::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Dictionary::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Dictionary::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Dictionary::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Dictionary::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Dictionary::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.
Parameters
tk: A reference to the
BStreamFileToolkitobject.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
Returns
The result of the function call.
-
TK_Status
TK_Dictionary::Interpret(BStreamFileToolkit &tk, ID_Key key, char const *special) 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.
Parameters
tk: A reference to the
BStreamFileToolkitobject.key: An identifier to the object (for example, the HOOPS key of a geometry item)
special: A string value of particular data
Returns
The result of the function call.
-
void
TK_Dictionary::Reset() virtual
Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.
Variables
-
unsigned char
TK_Dictionary::m_format protected
unsigned charinternal use
-
int
TK_Dictionary::m_placeholder protected
intinternal use
-
unsigned char
TK_Dictionary::m_present protected
unsigned charinternal use
-
int
TK_Dictionary::m_number_of_items protected
intinternal use
-
Internal_Translator::Index_Key_Pair *
TK_Dictionary::m_item protected
Internal_Translator::Index_Key_Pairinternal use; cache lookup in Pending cases