TK_Referenced_Segment

Detailed Description

class TK_Referenced_Segment : public BBaseOpcodeHandler

Handles the TKE_Inlude_Segment TKE_Named_Style and TKE_Style_Segment opcodes.

TK_Referenced_Segment provides support for writing/reading the TKE_Inlude_Segment TKE_Named_Style and TKE_Style_Segment opcode objects to/from an HSF file.

The HOOPS/3dGS scene-graph nodes are called ‘segments’ which store, geometry, attributes, and subsegments. The scene-graph provides support for referencing segments where they can either be ‘included’ as virtual subsegments, or they can be ‘styled’ so that only the attributes are referenced.

Subclassed by HTK_Referenced_Segment

Public Functions

TK_Referenced_Segment(unsigned char opcode)

constructor

~TK_Referenced_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

void SetCondition(char const *condition)

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

void SetCondition(int length)

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

inline char const *GetCondition() const

Get the condition string. Returns a pointer to the current condition

inline char *GetCondition()

Get the condition string buffer. Returns a pointer to the current condition buffer which may then be modified directly

inline void SetFollow(bool f)

Sets the flag indicating whether the reference segment should be processed itself

inline bool GetFollow()

Returns the flag indicating whether the reference segment should be processed itself