TK_Open_Segment

class TK_Open_Segment

Handles the TKE_Open_Segment opcode.

TK_Open_Segment provides support for writing/reading the TKE_Open_Segment opcode object to/from an HSF file.

The nodes in the HOOPS/3dGS scene-graph are called ‘segments’ which store, geometry, attributes, and subsegments. After a HOOPS segment is open, geometry which should reside in that segment should be exported. Similarly, any attributes which need to affect the geometry in that segment should be exported.

This should be matched with a TKE_Close_Segment opcode object.

Inherits from: BBaseOpcodeHandler

Methods

void TK_Open_Segment::set_segment(char const *segment)

protected

internal use

void TK_Open_Segment::set_segment(int length)

protected

internal use

TK_Open_Segment::TK_Open_Segment()

constructor

TK_Open_Segment::~TK_Open_Segment()
TK_Status TK_Open_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

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Open_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

tk: A reference to the BStreamFileToolkit object.

Returns

The result of the function call.
TK_Status TK_Open_Segment::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_Open_Segment::ReadAscii(BStreamFileToolkit &tk)

Deprecated.

TK_Status TK_Open_Segment::WriteAscii(BStreamFileToolkit &tk)

Deprecated.

void TK_Open_Segment::Reset()

virtual

Resets the current opcode handler. This is called by the toolkit when it is done processing an opcode. This method reinitializes any opcode handler variables and frees up temporary data.

void TK_Open_Segment::SetSegment(char const *segment)

Set the segment name. Makes sure the buffer is big enough to hold the segment name, and copies it in

void TK_Open_Segment::SetSegment(int length)

Set the segment name. Makes sure the buffer is big enough to hold a string of ‘length’ characters

char const *TK_Open_Segment::GetSegment() const

const

Get the segment name. Returns a pointer to the current segment name

char *TK_Open_Segment::GetSegment()

Get the segment name buffer. Returns a pointer to the current segment name buffer which may then be modified directly

Variables

int TK_Open_Segment::m_length

protected

int

Length of segment string name

int TK_Open_Segment::m_allocated

protected

int

Size of currently available string buffer

char *TK_Open_Segment::m_string

protected

char

Segment name