TK_User_Value Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_User_Value:

Inheritance graph
[legend]
Collaboration diagram for TK_User_Value:

Collaboration graph
[legend]
List of all members.

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 long integer.

Definition at line 4926 of file BOpcodeHandler.h.

Public Member Functions

 TK_User_Value ()
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetValue (long v) alter
long GetValue (void) const

Protected Attributes

long m_value
 for internal use only


Constructor & Destructor Documentation

TK_User_Value::TK_User_Value  )  [inline]
 

constructor

Definition at line 4936 of file BOpcodeHandler.h.


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.

long TK_User_Value::GetValue void   )  const [inline]
 

Returns the user value

Definition at line 4949 of file BOpcodeHandler.h.

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 long  v  )  [inline]
 

Sets the user value

Definition at line 4947 of file BOpcodeHandler.h.

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:
Generated on Tue Jan 6 22:41:48 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5