TK_Selectability
-
class
TK_Selectability Handles the TKE_Selectability opcode.
TK_Selectabilityprovides 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.
Inherits from:
BBaseOpcodeHandler
Methods
-
TK_Selectability::TK_Selectability(void) constructor
-
TK_Status
TK_Selectability::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Selectability::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 theBStreamFileToolkitobject.Returns
The result of the function call.
-
TK_Status
TK_Selectability::Clone(BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const const virtual
Copies the opcode handler
Parameters
tk: A reference to the
BStreamFileToolkitobject.handler: A pointer to the opcode handler object. Passed by reference.
Returns
The result of the function call.
-
TK_Status
TK_Selectability::ReadAscii(BStreamFileToolkit &tk) Deprecated.
-
TK_Status
TK_Selectability::WriteAscii(BStreamFileToolkit &tk) Deprecated.
-
void
TK_Selectability::SetGeometry(int m) Sets the mask indicating which geometries have a selectability setting. Geometry types are specified by
TKO_Geometry_Bits.
-
int
TK_Selectability::GetGeometry() const const
Returns the mask indicating which geometries have a selectability setting. Geometry types are specified by
TKO_Geometry_Bits.
-
void
TK_Selectability::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.
-
int
TK_Selectability::GetDown() const const
Returns the mask indicating which geometries have selectability set “down”. Geometry types are specified by
TKO_Geometry_Bits.
-
void
TK_Selectability::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.
-
int
TK_Selectability::GetUp() const const
Returns the mask indicating which geometries have selectability set “up”. Geometry types are specified by
TKO_Geometry_Bits.
-
void
TK_Selectability::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.
-
int
TK_Selectability::GetMoveDown() const const
Returns the mask indicating which geometries have selectability set “move down”. Geometry types are specified by
TKO_Geometry_Bits.
-
void
TK_Selectability::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.
-
int
TK_Selectability::GetMoveUp() const const
Returns the mask indicating which geometries have selectability set “move up”. Geometry types are specified by
TKO_Geometry_Bits.
-
void
TK_Selectability::SetWhenInvisible(int m) Sets the mask indicating which geometries are selectable even when not visible. Geometry types are specified by
TKO_Geometry_Bits.
-
int
TK_Selectability::GetWhenInvisible() const const
Returns the mask indicating which geometries are selectable when not visible. Geometry types are specified by
TKO_Geometry_Bits.
Variables
-
int
TK_Selectability::m_mask protected
intinternal use; specifies which selectability settings are active (and hence, which are valid). For internal use only.
-
int
TK_Selectability::m_down protected
intinternal use; specifies what geometry is selectable on mouse button down. For internal use only.
-
int
TK_Selectability::m_up protected
intinternal use; specifies what geometry is selectable on mouse button up. For internal use only.
-
int
TK_Selectability::m_move_down protected
intinternal use; specifies what geometry is selectable on mouse button down and move. For internal use only.
-
int
TK_Selectability::m_move_up protected
intinternal use; specifies what geometry is selectable on mouse move without buttons down. For internal use only.
-
int
TK_Selectability::m_invisible protected
intinternal use; specifies what geometry is selectable even when invisible. For internal use only.