OCC Main Page | Visualization | Toolkits | Packages | Class Hierarchy | Data Structures | File List | Data Fields | Globals

Visualization
TKV3d
Select3D


Select3D_SensitiveGroup Class Reference

A framework to define selection of a sensitive group
by a sensitive entity which is a set of 3D sensitive entities.
Remark: 2 modes are possible for rectangle selection
the group is considered selected
1) when all the entities inside are selected in the rectangle
2) only one entity inside is selected by the rectangle
By default the "Match All entities" mode is set.
.

#include <Select3D_SensitiveGroup.hxx>

Inheritance diagram for Select3D_SensitiveGroup:

Inheritance graph
[legend]

Public Member Functions

Standard_EXPORT Select3D_SensitiveGroup (const Handle(SelectBasics_EntityOwner)&OwnerId, const Standard_Boolean MatchAll=Standard_True)
 Constructs an empty sensitive group object.
This is a set of sensitive 3D entities. The sensitive
entities will be defined using the function Add to fill
the entity owner OwnerId. If MatchAll is false, nothing can be added.
.
Standard_EXPORT Select3D_SensitiveGroup (const Handle(SelectBasics_EntityOwner)&OwnerId, Select3D_ListOfSensitive &TheList, const Standard_Boolean MatchAll=Standard_True)
 Constructs a sensitive group object defined by the list
TheList and the entity owner OwnerId. If MatchAll is false, nothing is done.
.
Standard_EXPORT void Add (Select3D_ListOfSensitive &LL)
 Adds the list of sensitive entities LL to the empty
sensitive group object created at construction time.
.
Standard_EXPORT void Add (const Handle(Select3D_SensitiveEntity)&aSensitive)
 Adds the sensitive entity aSensitive to the non-empty
sensitive group object created at construction time.
.
Standard_EXPORT void Remove (const Handle(Select3D_SensitiveEntity)&aSensitive)
Standard_EXPORT void Clear ()
 Removes all sensitive entities from the list used at the
time of construction, or added using the function Add.
.
Standard_EXPORT Standard_Boolean IsIn (const Handle(Select3D_SensitiveEntity)&aSensitive) const
 Returns true if the sensitive entity aSensitive is in
the list used at the time of construction, or added using the function Add.
.
void Set (const Standard_Boolean MustMatchAllEntities)
 Sets the requirement that all sensitive entities in the
list used at the time of construction, or added using
the function Add must be matched.
.
Standard_Boolean MustMatchAll () const
 Returns true if all sensitive entities in the list used
at the time of construction, or added using the function Add must be matched.
.
Standard_EXPORT void Project (const Select3D_Projector &aProjector)
 projection of the sensitive primitive in order to
get 2D boxes for the Sort Algorithm

Standard_EXPORT void Areas (SelectBasics_ListOfBox2d &boxes)
 gives the 2D boxes which represent the segment in the
selection process...

Standard_EXPORT Standard_Integer MaxBoxes () const
 Returns the max number of sensitive areas returned
by this class is 1 by default.
Else on must redefine this method.
.
Standard_EXPORT Handle_Select3D_SensitiveEntity GetConnected (const TopLoc_Location &aLocation)
 Returns the sensitive entity found at the location aLocation.
You must redefine this function for any type of
sensitive entity which can accept another connected
sensitive entity.//can be connected to another sensitive entity.
.
Standard_EXPORT void SetLocation (const TopLoc_Location &aLoc)
 propagation of location on all the sensitive inside...

Standard_EXPORT void ResetLocation ()
 propagation of location on all the sensitive inside...

Standard_EXPORT Standard_Boolean Matches (const Standard_Real X, const Standard_Real Y, const Standard_Real aTol, Standard_Real &DMin)
 projection of the sensitive primitive in order to
get 2D boxes for the Sort Algorithm

Standard_EXPORT Standard_Boolean Matches (const Standard_Real XMin, const Standard_Real YMin, const Standard_Real XMax, const Standard_Real YMax, const Standard_Real aTol)
 Matches the box defined by the coordinates Xmin,
Ymin, Xmax, Ymax with the entity found at that point
within the tolerance aTol.
Xmin, YMin define the minimum point in the lower left
hand corner of the box, and XMax, YMax define the
maximum point in the upper right hand corner of the box.
You must redefine this function for every inheriting entity.
You will have to call this framework inside the redefined function.
.
virtual Standard_EXPORT Standard_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods...

Standard_EXPORT Standard_Real ComputeDepth (const gp_Lin &EyeLine) const
 returns the depth of the touched entity

virtual Standard_EXPORT void SetLastPrj (const Select3D_Projector &aPrj)
Standard_EXPORT const Handle (Standard_Type)&DynamicType() const

Private Attributes

Select3D_ListOfSensitive myList
Standard_Boolean myMustMatchAll
Standard_Integer myLastRank
Standard_ShortReal myLastTol
Standard_ShortReal myX
Standard_ShortReal myY

Constructor & Destructor Documentation

Standard_EXPORT Select3D_SensitiveGroup::Select3D_SensitiveGroup const Handle(SelectBasics_EntityOwner)&  OwnerId,
const Standard_Boolean  MatchAll = Standard_True
 

Standard_EXPORT Select3D_SensitiveGroup::Select3D_SensitiveGroup const Handle(SelectBasics_EntityOwner)&  OwnerId,
Select3D_ListOfSensitive TheList,
const Standard_Boolean  MatchAll = Standard_True
 


Member Function Documentation

Standard_EXPORT void Select3D_SensitiveGroup::Add const Handle(Select3D_SensitiveEntity)&  aSensitive  ) 
 

Standard_EXPORT void Select3D_SensitiveGroup::Add Select3D_ListOfSensitive LL  ) 
 

Standard_EXPORT void Select3D_SensitiveGroup::Areas SelectBasics_ListOfBox2d boxes  )  [virtual]
 

Implements SelectBasics_SensitiveEntity.

Standard_EXPORT void Select3D_SensitiveGroup::Clear  ) 
 

Standard_EXPORT Standard_Real Select3D_SensitiveGroup::ComputeDepth const gp_Lin &  EyeLine  )  const [virtual]
 

Implements Select3D_SensitiveEntity.

Standard_EXPORT Handle_Select3D_SensitiveEntity Select3D_SensitiveGroup::GetConnected const TopLoc_Location &  aLocation  )  [virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT const Select3D_SensitiveGroup::Handle Standard_Type   )  const
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT Standard_Boolean Select3D_SensitiveGroup::IsIn const Handle(Select3D_SensitiveEntity)&  aSensitive  )  const
 

virtual Standard_EXPORT Standard_Boolean Select3D_SensitiveGroup::Matches const TColgp_Array1OfPnt2d &  Polyline,
const Bnd_Box2d &  aBox,
const Standard_Real  aTol
[virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT Standard_Boolean Select3D_SensitiveGroup::Matches const Standard_Real  XMin,
const Standard_Real  YMin,
const Standard_Real  XMax,
const Standard_Real  YMax,
const Standard_Real  aTol
[virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT Standard_Boolean Select3D_SensitiveGroup::Matches const Standard_Real  X,
const Standard_Real  Y,
const Standard_Real  aTol,
Standard_Real &  DMin
[virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT Standard_Integer Select3D_SensitiveGroup::MaxBoxes  )  const [virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_Boolean Select3D_SensitiveGroup::MustMatchAll  )  const [inline]
 

Standard_EXPORT void Select3D_SensitiveGroup::Project const Select3D_Projector aProjector  )  [virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT void Select3D_SensitiveGroup::Remove const Handle(Select3D_SensitiveEntity)&  aSensitive  ) 
 

Standard_EXPORT void Select3D_SensitiveGroup::ResetLocation  )  [virtual]
 

Reimplemented from Select3D_SensitiveEntity.

void Select3D_SensitiveGroup::Set const Standard_Boolean  MustMatchAllEntities  )  [inline]
 

virtual Standard_EXPORT void Select3D_SensitiveGroup::SetLastPrj const Select3D_Projector aPrj  )  [virtual]
 

Reimplemented from Select3D_SensitiveEntity.

Standard_EXPORT void Select3D_SensitiveGroup::SetLocation const TopLoc_Location &  aLoc  )  [virtual]
 

Reimplemented from Select3D_SensitiveEntity.


Field Documentation

Standard_Integer Select3D_SensitiveGroup::myLastRank [private]
 

Standard_ShortReal Select3D_SensitiveGroup::myLastTol [private]
 

Select3D_ListOfSensitive Select3D_SensitiveGroup::myList [private]
 

Standard_Boolean Select3D_SensitiveGroup::myMustMatchAll [private]
 

Standard_ShortReal Select3D_SensitiveGroup::myX [private]
 

Standard_ShortReal Select3D_SensitiveGroup::myY [private]
 


The documentation for this class was generated from the following files:
Generated on Mon Aug 25 13:56:12 2008 for OpenCASCADE by  doxygen 1.4.1