Alphabetical Class Index   Class Hierarchy   Compound Members   File Members   File List  

TK_Selectability Class Reference

Handles the TKE_Selectability opcode. More...

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Selectability:

BBaseOpcodeHandler BControlledMemoryObject

List of all members.

Public Member Functions

TK_Status Clone (BStreamFileToolkit &tk, BBaseOpcodeHandler **handler) const
int GetDown () const
int GetGeometry () const
int GetMoveDown () const
int GetMoveUp () const
int GetUp () const
int GetWhenInvisible () const
TK_Status Read (BStreamFileToolkit &tk)
TK_Status ReadAscii (BStreamFileToolkit &tk)
 Deprecated.
void SetDown (int m)
void SetGeometry (int m)
void SetMoveDown (int m)
void SetMoveUp (int m)
void SetUp (int m)
void SetWhenInvisible (int m)
 TK_Selectability (void)
TK_Status Write (BStreamFileToolkit &tk)
TK_Status WriteAscii (BStreamFileToolkit &tk)
 Deprecated.

Protected Attributes

int m_down
 internal use; specifies what geometry is selectable on mouse button down. For internal use only.
int m_invisible
 internal use; specifies what geometry is selectable even when invisible. For internal use only.
int m_mask
 internal use; specifies which selectability settings are active (and hence, which are valid). For internal use only.
int m_move_down
 internal use; specifies what geometry is selectable on mouse button down and move. For internal use only.
int m_move_up
 internal use; specifies what geometry is selectable on mouse move without buttons down. For internal use only.
int m_up
 internal use; specifies what geometry is selectable on mouse button up. For internal use only.


Detailed Description

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.


Constructor & Destructor Documentation

TK_Selectability::TK_Selectability ( void   )  [inline]

constructor


Member Function Documentation

TK_Status TK_Selectability::Clone ( BStreamFileToolkit tk,
BBaseOpcodeHandler **  handler 
) const [virtual]

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.

Reimplemented from BBaseOpcodeHandler.

int TK_Selectability::GetDown (  )  const [inline]

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

int TK_Selectability::GetGeometry (  )  const [inline]

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

int TK_Selectability::GetMoveDown (  )  const [inline]

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

int TK_Selectability::GetMoveUp (  )  const [inline]

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

int TK_Selectability::GetUp (  )  const [inline]

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

int TK_Selectability::GetWhenInvisible (  )  const [inline]

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

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 the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.

void TK_Selectability::SetDown ( int  m  )  [inline]

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.

void TK_Selectability::SetGeometry ( int  m  )  [inline]

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

References TKO_Geo_All_Selects, TKO_Geo_Extended, and TKO_Geo_Extended_Mask.

void TK_Selectability::SetMoveDown ( int  m  )  [inline]

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.

void TK_Selectability::SetMoveUp ( int  m  )  [inline]

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.

void TK_Selectability::SetUp ( int  m  )  [inline]

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.

void TK_Selectability::SetWhenInvisible ( int  m  )  [inline]

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

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 the BStreamFileToolkit object.
Returns:
The result of the function call.

Implements BBaseOpcodeHandler.


The documentation for this class was generated from the following file: