TK_Dictionary_Locater
-
class
TK_Dictionary_Locater Handles the TKE_Dictionary_Locater opcode.
TK_Dictionary_Locaterprovides support for writing/reading the TKE_Dictionary_Locater opcode object to/from an HSF file.The dictionary provides a mean for locating specific entities in the file, the locater will be placed at the end of the file if the dictionary itself isn’t. See the Programming Guide for more detailed information.
Inherits from:
BBaseOpcodeHandlerIndex
Methods
Execute()GetOffset()GetSize()Interpret()Interpret()Read()ReadAscii()Reset()SetOffset()SetSize()TK_Dictionary_Locater()Write()WriteAscii()
Variables
Methods
-
TK_Dictionary_Locater::TK_Dictionary_Locater() constructor
-
TK_Status
TK_Dictionary_Locater::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_Locater::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_Locater::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Dictionary_Locater::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Dictionary_Locater::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_Locater::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_Locater::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_Locater::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.
-
void
TK_Dictionary_Locater::SetSize(int size) Sets the size value
-
int
TK_Dictionary_Locater::GetSize() const const
Returns the size value
-
void
TK_Dictionary_Locater::SetOffset(int offset) Sets the offset value
-
int
TK_Dictionary_Locater::GetOffset() const const
Returns the offset value
Variables
-
int
TK_Dictionary_Locater::m_size protected
intinternal use
-
int
TK_Dictionary_Locater::m_offset protected
intinternal use