TK_Open_Segment

Functions

	TK_Open_Segment
	~TK_Open_Segment
TK_Status	Read
TK_Status	Write
TK_Status	Clone
TK_Status	ReadAscii
TK_Status	WriteAscii
void	Reset
void	SetSegment
void	SetSegment
char const *	GetSegment
char *	GetSegment

Detailed Description

class TK_Open_Segment : public BBaseOpcodeHandler

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.

Public Functions

inline TK_Open_Segment()

constructor

~TK_Open_Segment()

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.

virtual void Reset()

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.

inline void SetSegment(char const *segment)

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

inline void SetSegment(int length)

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

inline char const *GetSegment() const

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

inline char *GetSegment()

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