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 > &theOwnerId, const Standard_Boolean theIsMustMatchAll=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 > &theOwnerId, Select3D_EntitySequence &theEntities, const Standard_Boolean theIsMustMatchAll=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_EntitySequence &theEntities) |
| Adds the list of sensitive entities LL to the empty sensitive group object created at construction time. More... | |
| void | Add (const Handle< Select3D_SensitiveEntity > &theSensitive) |
| Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time. More... | |
| void | Remove (const Handle< Select3D_SensitiveEntity > &theSensitive) |
| void | Clear () override |
| 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 > &theSensitive) 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 | SetMatchType (const Standard_Boolean theIsMustMatchAll) |
| 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... | |
| virtual Standard_Boolean | Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override |
| Checks whether the group overlaps current selecting volume. More... | |
| virtual Standard_Integer | NbSubElements () override |
| Returns the amount of sub-entities. More... | |
| virtual Handle< Select3D_SensitiveEntity > | GetConnected () override |
| 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 | Set (const Handle< SelectBasics_EntityOwner > &theOwnerId) override |
| Sets the owner for all entities in group. More... | |
| const Select3D_EntitySequence & | GetEntities () const |
| Gets group content. More... | |
| virtual Select3D_BndBox3d | BoundingBox () override |
| Returns bounding box of the group. If location transformation is set, it will be applied. More... | |
| virtual gp_Pnt | CenterOfGeometry () const override |
| Returns center of entity set. If location transformation is set, it will be applied. More... | |
| virtual Select3D_BndBox3d | Box (const Standard_Integer theIdx) const override |
| Returns bounding box of sensitive entity with index theIdx. More... | |
| virtual Standard_Real | Center (const Standard_Integer theIdx, const Standard_Integer theAxis) const override |
| Returns geometry center of sensitive entity index theIdx in the vector along the given axis theAxis. More... | |
| virtual void | Swap (const Standard_Integer theIdx1, const Standard_Integer theIdx2) override |
| Swaps items with indexes theIdx1 and theIdx2 in the vector. More... | |
| virtual Standard_Integer | Size () const override |
| Returns the length of vector of sensitive entities. More... | |
 Public Member Functions inherited from Select3D_SensitiveSet | |
| Select3D_SensitiveSet (const Handle< SelectBasics_EntityOwner > &theOwnerId) | |
| Creates new empty sensitive set and its content. More... | |
| ~Select3D_SensitiveSet () | |
| void | BVH () override |
| Builds BVH tree for sensitive set. Must be called manually to build BVH tree for any sensitive set in case if its content was initialized not in a constructor, but element by element. More... | |
| void | MarkDirty () |
| Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH() More... | |
| Standard_Integer | GetLeafNodeSize () const |
| Returns a number of nodes in 1 BVH leaf. More... | |
| Public Member Functions inherited from Select3D_SensitiveEntity | |
| virtual Standard_Boolean | HasInitLocation () const override |
| Returns true if the shape corresponding to the entity has init location. More... | |
| virtual gp_Trsf | InvInitLocation () const override |
| Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix. More... | |
| Public Member Functions inherited from SelectBasics_SensitiveEntity | |
| const Handle< SelectBasics_EntityOwner > & | OwnerId () const |
| Returns pointer to owner of the entity. More... | |
| Standard_Integer | SensitivityFactor () const |
| allows a better sensitivity for a specific entity in selection algorithms useful for small sized entities. More... | |
| void | SetSensitivityFactor (const Standard_Integer theNewSens) |
| Allows to manage sensitivity of a particular sensitive entity. More... | |
| Public Member Functions inherited from MMgt_TShared | |
| virtual void | Delete () const override |
| Memory deallocator for transient classes. More... | |
| Public Member Functions inherited from Standard_Transient | |
| 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 opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. More... | |
| Standard_Boolean | IsInstance (const opencascade::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 opencascade::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... | |
| Standard_Transient * | This () const |
| Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
| Standard_Integer | GetRefCount () const |
| Get the reference counter of this object. More... | |
| void | IncrementRefCounter () const |
| Increments the reference counter of this object. More... | |
| Standard_Integer | DecrementRefCounter () const |
| Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
| Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. More... | |
| Static Public Member Functions inherited from Standard_Transient | |
| static const char * | get_type_name () |
| Returns a type descriptor about this object. More... | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. More... | |
| Protected Member Functions inherited from Select3D_SensitiveEntity | |
| Select3D_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId) | |
| Protected Member Functions inherited from SelectBasics_SensitiveEntity | |
| SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId) | |
| Protected Attributes inherited from Select3D_SensitiveSet | |
| Standard_Integer | myDetectedIdx |
| Index of detected primitive in BVH sorted primitive array, for debug purposes. More... | |
| Protected Attributes inherited from SelectBasics_SensitiveEntity | |
| Handle< SelectBasics_EntityOwner > | myOwnerId |
Detailed Description
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.
Constructor & Destructor Documentation
| Select3D_SensitiveGroup::Select3D_SensitiveGroup | ( | const Handle< SelectBasics_EntityOwner > & | theOwnerId, |
| const Standard_Boolean | theIsMustMatchAll = 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 > & | theOwnerId, |
| Select3D_EntitySequence & | theEntities, | ||
| const Standard_Boolean | theIsMustMatchAll = Standard_True |
||
| ) |
Constructs a sensitive group object defined by the list TheList and the entity owner OwnerId. If MatchAll is false, nothing is done.
Member Function Documentation
| void Select3D_SensitiveGroup::Add | ( | Select3D_EntitySequence & | theEntities | ) |
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 > & | theSensitive | ) |
Adds the sensitive entity aSensitive to the non-empty sensitive group object created at construction time.
|
overridevirtual |
Returns bounding box of the group. If location transformation is set, it will be applied.
Reimplemented from Select3D_SensitiveSet.
|
overridevirtual |
Returns bounding box of sensitive entity with index theIdx.
Implements Select3D_SensitiveSet.
|
overridevirtual |
Returns geometry center of sensitive entity index theIdx in the vector along the given axis theAxis.
Implements Select3D_SensitiveSet.
|
overridevirtual |
Returns center of entity set. If location transformation is set, it will be applied.
Reimplemented from Select3D_SensitiveSet.
|
overridevirtual |
Removes all sensitive entities from the list used at the time of construction, or added using the function Add.
Reimplemented from Select3D_SensitiveSet.
|
overridevirtual |
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_EntitySequence& Select3D_SensitiveGroup::GetEntities | ( | ) | const |
Gets group content.
| Standard_Boolean Select3D_SensitiveGroup::IsIn | ( | const Handle< Select3D_SensitiveEntity > & | theSensitive | ) | const |
Returns true if the sensitive entity aSensitive is in the list used at the time of construction, or added using the function Add.
|
overridevirtual |
Checks whether the group overlaps current selecting volume.
Reimplemented from Select3D_SensitiveSet.
| 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.
|
overridevirtual |
Returns the amount of sub-entities.
Implements Select3D_SensitiveEntity.
| void Select3D_SensitiveGroup::Remove | ( | const Handle< Select3D_SensitiveEntity > & | theSensitive | ) |
|
overridevirtual |
Sets the owner for all entities in group.
Reimplemented from SelectBasics_SensitiveEntity.
| void Select3D_SensitiveGroup::SetMatchType | ( | const Standard_Boolean | theIsMustMatchAll | ) |
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.
|
overridevirtual |
Returns the length of vector of sensitive entities.
Implements Select3D_SensitiveSet.
|
overridevirtual |
Swaps items with indexes theIdx1 and theIdx2 in the vector.
Implements Select3D_SensitiveSet.
The documentation for this class was generated from the following file:
