TK_User_Index
-
class
TK_User_Index Handles the TKE_User_Index opcode.
TK_User_Indexprovides support for writing/reading the TKE_User_Index opcode object to/from an HSF file.The HOOPS/3dGS scene-graph supports storing non-graphical data per segment. A user-index is an index into a list of user options.
Inherits from:
BBaseOpcodeHandler
Methods
-
void
TK_User_Index::set_indices(int count, int const indices[], long const values[]) protected
for internal use only
-
void
TK_User_Index::set_indices(int count) protected
for internal use only
-
TK_User_Index::TK_User_Index() constructor
-
TK_User_Index::~TK_User_Index()
-
TK_Status
TK_User_Index::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_Index::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_Index::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_Index::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_User_Index::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_User_Index::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_User_Index::SetIndices(int count, int const indices[], long const values[]) Sets the index-value pairs. Allocates buffers and copies the indices and values
-
void
TK_User_Index::SetIndices(int count) Sets the index-value pair buffers. Allocates buffers which can hold ‘count’ index-value pairs
-
int
TK_User_Index::GetCount() const const
Returns the current size of the buffers as the number of index-value pairs they can contain
-
int const *
TK_User_Index::GetIndices() const const
Returns the index array
-
int *
TK_User_Index::GetIndices() Returns the index array buffer, which may be modified directly
-
long const *
TK_User_Index::GetValues() const const
Returns the value array
-
long *
TK_User_Index::GetValues() Returns the value array buffer, which may be modified directly
Variables
-
int
TK_User_Index::m_count protected
intfor internal use only
-
int *
TK_User_Index::m_indices protected
intfor internal use only
-
long *
TK_User_Index::m_values protected
longfor internal use only
-
int
TK_User_Index::m_current_value protected
intfor internal use only