TK_Selectability Class Reference

#include <BOpcodeHandler.h>

Inheritance diagram for TK_Selectability:

Inheritance graph
[legend]
Collaboration diagram for TK_Selectability:

Collaboration graph
[legend]
List of all members.

Detailed Description

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.

Definition at line 4290 of file BOpcodeHandler.h.

Public Member Functions

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

Protected Attributes

int m_mask
 internal use; specifies which selectability settings are active (and hence, which are valid). For internal use only.
int m_down
 internal use; specifies what geometry is selectable on mouse button down. For internal use only.
int m_up
 internal use; specifies what geometry is selectable on mouse button up. 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_invisible
 internal use; specifies what geometry is selectable even when invisible. For internal use only.


Constructor & Destructor Documentation

TK_Selectability::TK_Selectability void   )  [inline]
 

constructor

Definition at line 4305 of file BOpcodeHandler.h.


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 void   )  const [inline]
 

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

Definition at line 4339 of file BOpcodeHandler.h.

int TK_Selectability::GetGeometry void   )  const [inline]
 

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

Definition at line 4328 of file BOpcodeHandler.h.

int TK_Selectability::GetMoveDown void   )  const [inline]
 

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

Definition at line 4361 of file BOpcodeHandler.h.

int TK_Selectability::GetMoveUp void   )  const [inline]
 

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

Definition at line 4372 of file BOpcodeHandler.h.

int TK_Selectability::GetUp void   )  const [inline]
 

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

Definition at line 4350 of file BOpcodeHandler.h.

int TK_Selectability::GetWhenInvisible void   )  const [inline]
 

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

Definition at line 4383 of file BOpcodeHandler.h.

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.

Definition at line 4334 of file BOpcodeHandler.h.

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.

Definition at line 4319 of file BOpcodeHandler.h.

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.

Definition at line 4356 of file BOpcodeHandler.h.

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.

Definition at line 4367 of file BOpcodeHandler.h.

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.

Definition at line 4345 of file BOpcodeHandler.h.

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.

Definition at line 4378 of file BOpcodeHandler.h.

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:
Generated on Tue Jan 6 22:41:46 2009 for Autodesk DWF 3D Toolkit by  doxygen 1.4.5