Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

Public Member Functions | Protected Attributes
TK_Streaming Class Reference

#include <BOpcodeHandler.h>

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
bool GetStreaming () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetStreaming (bool s)
 TK_Streaming ()
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

bool m_flag
 for internal use only

Detailed Description

TK_Streaming provides support for writing/reading the TKE_Streaming_Mode opcode.

The HOOPS/3dGS scene-graph supports a "streaming mode" in which the changes to a segment are treated as a procedural series instead of the normal mode where changes affect the state of the segment.


Constructor & Destructor Documentation

TK_Streaming::TK_Streaming ( ) [inline]

constructor


Member Function Documentation

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

bool TK_Streaming::GetStreaming ( ) const [inline]

Returns the flag indicating streaming mode

TK_Status TK_Streaming::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_Streaming::SetStreaming ( bool  s) [inline]

Sets the flag indicating streaming mode

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


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