TK_Reopen_Segment

Detailed Description

class TK_Reopen_Segment : public BBaseOpcodeHandler

Handles the TKE_Reopen_Segment opcode.

TKE_Reopen_Segment provides support for writing/reading the TKE_Close_Segment opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph nodes are called ‘segments’ which store, geometry, attributes, and subsegments.

The TKE_Reopen_Segment opcode indicates that an existing segment should be reopened to add more geometry, set additional attributes, etc…

The m_index variable represents the unique persistent identifier of the segment to be reopened.

Subclassed by HTK_Reopen_Segment

Public Functions

inline TK_Reopen_Segment()

constructor

virtual TK_Status Read(BStreamFileToolkit &tk)

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.
virtual TK_Status Write(BStreamFileToolkit &tk)

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

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 ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status WriteAscii(BStreamFileToolkit &tk)

Deprecated.

inline void SetIndex(int i)

Sets the index of the segment

inline int GetIndex() const

Returns the index of the segment