TK_File_Info
-
class
TK_File_Info Handles the TKE_File_Info opcode.
TK_File_Infoprovides support for writing/reading the TKE_File_Info opcode object to/from an HSF file.The TKE_File_Info opcode object contains information about how the file was written.
Inherits from:
BBaseOpcodeHandlerIndex
Methods
Execute()GetFlags()Interpret()Interpret()Read()ReadAscii()SetFlags()TK_File_Info()Write()WriteAscii()
Variables
Methods
-
TK_File_Info::TK_File_Info() constructor
-
TK_Status
TK_File_Info::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_File_Info::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_File_Info::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_File_Info::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_File_Info::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.
-
TK_Status
TK_File_Info::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_File_Info::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_File_Info::SetFlags(int f) Sets the flag indicating whether the reference segment should be processed itself
-
int
TK_File_Info::GetFlags() Returns the flag indicating whether the reference segment should be processed itself
Variables
-
int
TK_File_Info::m_flags protected
intinternal use