Open CASCADE Technology  6.5.4
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines
Public Member Functions
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

 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.

 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.

void Add (Select3D_ListOfSensitive &LL)
 Adds the list of sensitive entities LL to the empty
sensitive group object created at construction time.

void Add (const Handle< Select3D_SensitiveEntity > &aSensitive)
 Adds the sensitive entity aSensitive to the non-empty
sensitive group object created at construction time.

void Remove (const Handle< Select3D_SensitiveEntity > &aSensitive)
void Clear ()
 Removes all sensitive entities from the list used at the
time of construction, or added using the function Add.

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.

void Project (const Handle< Select3D_Projector > &aProjector)
 projection of the sensitive primitive in order to
get 2D boxes for the Sort Algorithm

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

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.

Handle_Select3D_SensitiveEntity GetConnected (const TopLoc_Location &aLocation)
 Originally this method intended to return sensitive
entity with new location aLocation, but currently sensitive
entities do not hold a location, instead HasLocation() and
Location() methods call corresponding entity owner's methods.
Thus all entities returned by GetConnected() share the same
location propagated from corresponding selectable object.
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.

void SetLocation (const TopLoc_Location &aLoc)
 propagation of location on all the sensitive inside...

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

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_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_Boolean Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol)
 prevents from hiding virtual methods...

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

virtual void SetLastPrj (const Handle< Select3D_Projector > &aPrj)
void Set (const Handle< SelectBasics_EntityOwner > &TheOwnerId)
 Sets the owner for all entities in group

const Select3D_ListOfSensitiveGetEntities () const
 Gets group content


Constructor & Destructor Documentation


Member Function Documentation

Handle_Select3D_SensitiveEntity Select3D_SensitiveGroup::GetConnected ( const TopLoc_Location aLocation) [virtual]

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from SelectBasics_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.

Reimplemented from Select3D_SensitiveEntity.


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