Open CASCADE Technology
6.8.0
|
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. More...
#include <Select3D_SensitiveGroup.hxx>
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. More... | |
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. More... | |
void | Add (Select3D_ListOfSensitive &LL) |
Adds the list of sensitive entities LL to the empty sensitive group object created at construction time. More... | |
void | Add (const Handle< Select3D_SensitiveEntity > &aSensitive) |
Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time. More... | |
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. More... | |
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. More... | |
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. More... | |
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. More... | |
void | Project (const Handle< Select3D_Projector > &aProjector) |
projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm More... | |
void | Areas (SelectBasics_ListOfBox2d &boxes) |
gives the 2D boxes which represent the segment in the selection process... More... | |
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. More... | |
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. More... | |
void | SetLocation (const TopLoc_Location &aLoc) |
propagation of location on all the sensitive inside... More... | |
void | ResetLocation () |
propagation of location on all the sensitive inside... More... | |
Standard_Boolean | Matches (const SelectBasics_PickArgs &thePickArgs, Standard_Real &theMatchDMin, Standard_Real &theMatchDepth) |
Checks whether the sensitive entity matches the picking detection area (close to the picking line). For details please refer to base class declaration. More... | |
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. More... | |
virtual Standard_Boolean | Matches (const TColgp_Array1OfPnt2d &Polyline, const Bnd_Box2d &aBox, const Standard_Real aTol) |
prevents from hiding virtual methods... More... | |
void | Set (const Handle< SelectBasics_EntityOwner > &TheOwnerId) |
Sets the owner for all entities in group. More... | |
const Select3D_ListOfSensitive & | GetEntities () const |
Gets group content. More... | |
![]() | |
Standard_Boolean | NeedsConversion () const |
Returns true if this framework needs conversion. More... | |
Standard_Boolean | Is3D () const |
Returns true if this framework provides 3D information. More... | |
virtual Standard_Boolean | HasLocation () const |
Returns true if this framework has a location defined. More... | |
virtual const TopLoc_Location | Location () const |
virtual void | Dump (Standard_OStream &S, const Standard_Boolean FullDump=Standard_True) const |
2 options : <FullDump> = False -> general information <FullDump> = True -> whole informtion 3D +2d ... More... | |
void | UpdateLocation (const TopLoc_Location &aLoc) |
![]() | |
const Handle < SelectBasics_EntityOwner > & | OwnerId () const |
void | SetSensitivityFactor (const Standard_ShortReal aFactor) |
Standard_ShortReal | SensitivityFactor () const |
allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. More... | |
![]() | |
virtual void | Delete () const |
Memory deallocator for transient classes. More... | |
![]() | |
Standard_Transient () | |
Empty constructor. More... | |
Standard_Transient (const Standard_Transient &) | |
Copy constructor – does nothing. More... | |
Standard_Transient & | operator= (const Standard_Transient &) |
Assignment operator, needed to avoid copying reference counter. More... | |
virtual | ~Standard_Transient () |
Destructor must be virtual. More... | |
virtual const Handle_Standard_Type & | DynamicType () const |
Returns a type information object about this object. More... | |
Standard_Boolean | IsInstance (const Handle_Standard_Type &theType) const |
Returns a true value if this is an instance of Type. More... | |
Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
Returns a true value if this is an instance of TypeName. More... | |
Standard_Boolean | IsKind (const Handle_Standard_Type &theType) const |
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
virtual Handle_Standard_Transient | This () const |
Returns a Handle which references this object. Must never be called to objects created in stack. More... | |
Standard_Integer | GetRefCount () const |
Get the reference counter of this object. More... | |
Additional Inherited Members | |
![]() | |
static void | DumpBox (Standard_OStream &S, const Bnd_Box2d &abox) |
![]() | |
Select3D_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &OwnerId) | |
![]() | |
SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &OwnerId, const Standard_ShortReal aSensitivityFactor=1) | |
![]() | |
Handle< SelectBasics_EntityOwner > | myOwnerId |
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.
Select3D_SensitiveGroup::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::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 Select3D_SensitiveGroup::Add | ( | Select3D_ListOfSensitive & | LL | ) |
Adds the list of sensitive entities LL to the empty sensitive group object created at construction time.
void Select3D_SensitiveGroup::Add | ( | const Handle< Select3D_SensitiveEntity > & | aSensitive | ) |
Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time.
|
virtual |
gives the 2D boxes which represent the segment in the selection process...
Implements SelectBasics_SensitiveEntity.
void Select3D_SensitiveGroup::Clear | ( | ) |
Removes all sensitive entities from the list used at the time of construction, or added using the function Add.
|
virtual |
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.
Reimplemented from Select3D_SensitiveEntity.
const Select3D_ListOfSensitive& Select3D_SensitiveGroup::GetEntities | ( | ) | const |
Gets group content.
Standard_Boolean Select3D_SensitiveGroup::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.
|
virtual |
Checks whether the sensitive entity matches the picking detection area (close to the picking line). For details please refer to base class declaration.
Implements SelectBasics_SensitiveEntity.
|
virtual |
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.
Reimplemented from Select3D_SensitiveEntity.
|
virtual |
prevents from hiding virtual methods...
Reimplemented from Select3D_SensitiveEntity.
|
virtual |
Returns the max number of sensitive areas returned by this class is 1 by default. Else on must redefine this method.
Reimplemented from Select3D_SensitiveEntity.
Standard_Boolean Select3D_SensitiveGroup::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.
|
virtual |
projection of the sensitive primitive in order to get 2D boxes for the Sort Algorithm
Implements Select3D_SensitiveEntity.
void Select3D_SensitiveGroup::Remove | ( | const Handle< Select3D_SensitiveEntity > & | aSensitive | ) |
|
virtual |
propagation of location on all the sensitive inside...
Reimplemented from Select3D_SensitiveEntity.
void Select3D_SensitiveGroup::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.
|
virtual |
Sets the owner for all entities in group.
Reimplemented from SelectBasics_SensitiveEntity.
|
virtual |
propagation of location on all the sensitive inside...
Reimplemented from Select3D_SensitiveEntity.