TK_Renumber

class TK_Renumber

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Renumber::TK_Renumber(unsigned char opcode, ID_Key key = 0)

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

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.
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.
TK_Status TK_Renumber::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const

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.
TK_Status TK_Renumber::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Renumber::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Renumber::SetKey(ID_Key k)

Sets the key (identifier) value

ID_Key TK_Renumber::GetKey() const

const

Returns the key (identifier) value

Variables

ID_Key TK_Renumber::m_key

protected

for internal use only