TK_Compression
-
class
TK_Compression Handles the TKE_Start_Compression and TKE_Stop_Compression opcodes.
TK_Compressionprovides support for writing/reading the TKE_Start_Compression and TKE_Stop_Compression opcode object to/from an HSF file.The TKE_Start_Compression and TKE_Stop_Compression opcode objects denote the beginning and end of global file compression.
Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Compression::TK_Compression(char opcode) constructor
-
TK_Status
TK_Compression::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_Compression::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_Compression::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Compression::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Compression::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_Compression::ExecuteAscii(BStreamFileToolkit &tk)
-
TK_Status
TK_Compression::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.
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_Compression::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.