TK_Renumber Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Renumber:

Inheritance graph
[legend]
Collaboration diagram for TK_Renumber:

Collaboration graph
[legend]
List of all members.

Detailed Description

Handles the TKE_Renumber_Key_Global, TKE_Renumber_Key_Local, and TKE_Priority opcodes.

TK_Renumber provides support for writing/reading the TKE_Renumber_Key_Global and TKE_Renumber_Key_Local opcode objects to/from an HSF file. This action operates on whatever entity was specified in the previous opcode.

The HOOPS/3dGS scene-graph supports the concept of renumbered keys. (Keys can refer to either segments or geometric primitives.) HOOPS entities that do not have keys (e.g. rendering options and other attributes) may not be renumbered. HOOPS/3DGS segments may hav a priority value assigned which overrides the default alphabetic sorting.

Definition at line 1582 of file BOpcodeHandler.h.

Public Member Functions

 TK_Renumber (unsigned char opcode, ID_Key key=0)
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
void SetKey (ID_Key k) alter
ID_Key GetKey (void) const

Protected Attributes

ID_Key m_key
 for internal use only


Constructor & Destructor Documentation

TK_Renumber::TK_Renumber unsigned char  opcode,
ID_Key  key = 0
[inline]
 

same as the default constructor in BBaseOpcodeHandler, except that a new key can optionally be provided directly at the time of construction

Definition at line 1594 of file BOpcodeHandler.h.


Member Function Documentation

TK_Status TK_Renumber::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.

ID_Key TK_Renumber::GetKey void   )  const [inline]
 

Returns the key (identifier) value

Definition at line 1605 of file BOpcodeHandler.h.

TK_Status TK_Renumber::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_Renumber::SetKey ID_Key  k  )  [inline]
 

Sets the key (identifier) value

Definition at line 1603 of file BOpcodeHandler.h.

TK_Status TK_Renumber::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:46 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5