TK_Selectability

Detailed Description

class TK_Selectability : public BBaseOpcodeHandler

Handles the TKE_Selectability opcode.

TK_Selectability provides support for writing/reading the TKE_Selectability opcode object to/from an HSF file.

The HOOPS/3dGS scene-graph supports an attribute called Selectability which affects the selection of objects. HOOPS’ selection is kicked off with an ::HC_Compute_Selection_By_[something], at which point one of several possible actions is given. Selectability attributes in HOOPS/3dGS allow for separate settings for each of those actions.

Subclassed by HTK_Selectability

Public Functions

inline TK_Selectability(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 selectability setting. Geometry types are specified by TKO_Geometry_Bits.

inline int GetGeometry() const

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

inline void SetDown(int m)

Sets the mask indicating which geometries are selected by a downward transition of the pointer (mouse click). Geometry types are specified by TKO_Geometry_Bits.

inline int GetDown() const

Returns the mask indicating which geometries have selectability set “down”. Geometry types are specified by TKO_Geometry_Bits.

inline void SetUp(int m)

Sets the mask indicating which geometries are selected by an upward transition of the pointer (mouse release). Geometry types are specified by TKO_Geometry_Bits.

inline int GetUp() const

Returns the mask indicating which geometries have selectability set “up”. Geometry types are specified by TKO_Geometry_Bits.

inline void SetMoveDown(int m)

Sets the mask indicating which geometries are selected by motion of the pointer in the “down” state. Geometry types are specified by TKO_Geometry_Bits.

inline int GetMoveDown() const

Returns the mask indicating which geometries have selectability set “move down”. Geometry types are specified by TKO_Geometry_Bits.

inline void SetMoveUp(int m)

Sets the mask indicating which geometries are selected by motion of the pointer in the “up” state. Geometry types are specified by TKO_Geometry_Bits.

inline int GetMoveUp() const

Returns the mask indicating which geometries have selectability set “move up”. Geometry types are specified by TKO_Geometry_Bits.

inline void SetWhenInvisible(int m)

Sets the mask indicating which geometries are selectable even when not visible. Geometry types are specified by TKO_Geometry_Bits.

inline int GetWhenInvisible() const

Returns the mask indicating which geometries are selectable when not visible. Geometry types are specified by TKO_Geometry_Bits.