TK_Streaming

class TK_Streaming

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.

Inherits from: BBaseOpcodeHandler

Methods

TK_Streaming::TK_Streaming()

constructor

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

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.
TK_Status TK_Streaming::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Streaming::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Streaming::SetStreaming(bool s)

Sets the flag indicating streaming mode

bool TK_Streaming::GetStreaming() const

const

Returns the flag indicating streaming mode

Variables

bool TK_Streaming::m_flag

protected

bool

for internal use only