TK_Streaming Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Streaming:

Inheritance graph
[legend]
Collaboration diagram for TK_Streaming:

Collaboration graph
[legend]
List of all members.

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.

Definition at line 4710 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Attributes

bool m_flag
 for internal use only


Constructor & Destructor Documentation

TK_Streaming::TK_Streaming  )  [inline]
 

constructor

Definition at line 4720 of file BOpcodeHandler.h.


Member Function Documentation

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

bool TK_Streaming::GetStreaming void   )  const [inline]
 

Returns the flag indicating streaming mode

Definition at line 4731 of file BOpcodeHandler.h.

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:
tk A 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

Definition at line 4729 of file BOpcodeHandler.h.

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