Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Reopen_Segment Class Reference

Handles the TKE_Reopen_Segment opcode. More...

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetIndex () const
TK_Status Read (BStreamFileToolkit &tk) alter
TK_Status ReadAscii (BStreamFileToolkit &tk) alter
 Deprecated.
void SetIndex (int i) alter
 TK_Reopen_Segment ()
TK_Status Write (BStreamFileToolkit &tk) alter
TK_Status WriteAscii (BStreamFileToolkit &tk) alter
 Deprecated.

Protected Attributes

int m_index

Detailed Description

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.


Constructor & Destructor Documentation

TK_Reopen_Segment::TK_Reopen_Segment ( ) [inline]

constructor


Member Function Documentation

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

Copies the opcode handler

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

Reimplemented from BBaseOpcodeHandler.

Reimplemented in HTK_Reopen_Segment.

int TK_Reopen_Segment::GetIndex ( ) const [inline]

Returns the index of the segment

TK_Status TK_Reopen_Segment::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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Reopen_Segment::SetIndex ( int  i) [inline]

Sets the index of the segment

TK_Status TK_Reopen_Segment::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:
tkA reference to the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


Member Data Documentation

int TK_Reopen_Segment::m_index [protected]

Represents the unique persistent identifier of the segment to be reopened


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