Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_User_Value Class Reference

Handles the TKE_User_Value opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_User_Value:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
HLONG GetValue () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetValue (HLONG v)
 TK_User_Value ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

HLONG m_value
 for internal use only


Detailed Description

Handles the TKE_User_Value opcode.

TK_User_Value provides 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.


Constructor & Destructor Documentation

TK_User_Value::TK_User_Value (  )  [inline]

constructor


Member Function Documentation

TK_Status TK_User_Value::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

Copies the opcode handler

Parameters:
tk A reference to the BStreamFileToolkit object.
handler A pointer to the opcode handler object. Passed by reference.
Returns:
The result of the function call.

Reimplemented from BBaseOpcodeHandler.

HLONG TK_User_Value::GetValue (  )  const [inline]

Returns the user value

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 the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_User_Value::SetValue ( HLONG  v  )  [inline]

Sets the user value

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 the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: