TK_User_Value
-
class
TK_User_Value Handles the TKE_User_Value opcode.
TK_User_Valueprovides support for writing/reading the TKE_User_Value opcode object to/from an HSF file.The HOOPS/3dGS scene-graph supports storing non-graphical data per segment. A user-value is a HLONG integer.
Inherits from:
BBaseOpcodeHandler
Methods
-
TK_User_Value::TK_User_Value() constructor
-
TK_Status
TK_User_Value::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_User_Value::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_User_Value::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_User_Value::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_User_Value::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_User_Value::SetValue(long v) Sets the user value
-
long
TK_User_Value::GetValue() const const
Returns the user value
Variables
-
long
TK_User_Value::m_value protected
longfor internal use only