TK_Streaming

Functions

TK_Streaming

TK_Status

Read

TK_Status

Write

TK_Status

Clone

TK_Status

ReadAscii

TK_Status

WriteAscii

void

SetStreaming

bool

GetStreaming

Detailed Description

class TK_Streaming : public BBaseOpcodeHandler

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.

Subclassed by HTK_Streaming

Public Functions

inline TK_Streaming()

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 SetStreaming(bool s)

Sets the flag indicating streaming mode

inline bool GetStreaming() const

Returns the flag indicating streaming mode