TK_Visibility

Detailed Description

class TK_Visibility : public BBaseOpcodeHandler

Handles the TKE_Visibility opcode.

TK_Visibility provides support for writing/reading the TKE_Visibility opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports an attribute called Visibility which affects the display of objects.

Public Functions

inline TK_Visibility(void)

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 SetGeometry(int m)

Sets the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.

inline int GetGeometry() const

Returns the mask indicating which geometries have a visibility setting. Geometry types are specified by TKO_Geometry_Bits.

inline void SetValue(int m)

Sets the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.

inline int GetValue() const

Returns the mask indicating which geometries have visibility set on. Geometry types are specified by TKO_Geometry_Bits.