Sensitive Entity to make a face selectable. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly. More...
#include <Select3D_SensitiveFace.hxx>
Public Member Functions | |
| Select3D_SensitiveFace (const Handle< SelectMgr_EntityOwner > &theOwnerId, const TColgp_Array1OfPnt &thePoints, const Select3D_TypeOfSensitivity theType) | |
| Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face. More... | |
| Select3D_SensitiveFace (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Handle< TColgp_HArray1OfPnt > &thePoints, const Select3D_TypeOfSensitivity theType) | |
| Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face. More... | |
| void | GetPoints (Handle< TColgp_HArray1OfPnt > &theHArrayOfPnt) |
| Initializes the given array theHArrayOfPnt by 3d coordinates of vertices of the face. More... | |
| virtual Standard_Boolean | Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override |
| Checks whether the face overlaps current selecting volume. 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. More... | |
| virtual Select3D_BndBox3d | BoundingBox () override |
| Returns bounding box of the face. If location transformation is set, it will be applied. More... | |
| virtual gp_Pnt | CenterOfGeometry () const override |
| Returns center of the face. If location transformation is set, it will be applied. More... | |
| virtual void | BVH () override |
| Builds BVH tree for the face. More... | |
| virtual Standard_Boolean | ToBuildBVH () const override |
| Returns TRUE if BVH tree is in invalidated state. More... | |
| virtual Standard_Integer | NbSubElements () const override |
| Returns the amount of sub-entities (points or planar convex polygons) More... | |
| virtual void | DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override |
| Dumps the content of me into the stream. More... | |
 Public Member Functions inherited from Select3D_SensitiveEntity | |
| const Handle< SelectMgr_EntityOwner > & | OwnerId () const |
| Returns pointer to owner of the entity. More... | |
| virtual void | Set (const Handle< SelectMgr_EntityOwner > &theOwnerId) |
| Sets 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... | |
| virtual void | Clear () |
| Clears up all resources and memory. More... | |
| virtual Standard_Boolean | HasInitLocation () const |
| Returns true if the shape corresponding to the entity has init location. More... | |
| virtual gp_GTrsf | InvInitLocation () const |
| 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 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 void | Delete () const |
| Memory deallocator for transient classes. 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< SelectMgr_EntityOwner > &theOwnerId) | |
| Protected Attributes inherited from Select3D_SensitiveEntity | |
| Handle< SelectMgr_EntityOwner > | myOwnerId |
| Standard_Integer | mySFactor |
Detailed Description
Sensitive Entity to make a face selectable. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
Constructor & Destructor Documentation
◆ Select3D_SensitiveFace() [1/2]
| Select3D_SensitiveFace::Select3D_SensitiveFace | ( | const Handle< SelectMgr_EntityOwner > & | theOwnerId, |
| const TColgp_Array1OfPnt & | thePoints, | ||
| const Select3D_TypeOfSensitivity | theType | ||
| ) |
Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face.
◆ Select3D_SensitiveFace() [2/2]
| Select3D_SensitiveFace::Select3D_SensitiveFace | ( | const Handle< SelectMgr_EntityOwner > & | theOwnerId, |
| const Handle< TColgp_HArray1OfPnt > & | thePoints, | ||
| const Select3D_TypeOfSensitivity | theType | ||
| ) |
Constructs a sensitive face object defined by the owner theOwnerId, the array of points thePoints, and the sensitivity type theType. The array of points is the outer polygon of the geometric face.
Member Function Documentation
◆ BoundingBox()
|
overridevirtual |
Returns bounding box of the face. If location transformation is set, it will be applied.
Implements Select3D_SensitiveEntity.
◆ BVH()
|
overridevirtual |
Builds BVH tree for the face.
Reimplemented from Select3D_SensitiveEntity.
◆ CenterOfGeometry()
|
overridevirtual |
Returns center of the face. If location transformation is set, it will be applied.
Implements Select3D_SensitiveEntity.
◆ DumpJson()
|
overridevirtual |
Dumps the content of me into the stream.
Reimplemented from Select3D_SensitiveEntity.
◆ GetConnected()
|
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.
Reimplemented from Select3D_SensitiveEntity.
◆ GetPoints()
| void Select3D_SensitiveFace::GetPoints | ( | Handle< TColgp_HArray1OfPnt > & | theHArrayOfPnt | ) |
Initializes the given array theHArrayOfPnt by 3d coordinates of vertices of the face.
◆ Matches()
|
overridevirtual |
Checks whether the face overlaps current selecting volume.
Implements Select3D_SensitiveEntity.
◆ NbSubElements()
|
overridevirtual |
Returns the amount of sub-entities (points or planar convex polygons)
Implements Select3D_SensitiveEntity.
◆ ToBuildBVH()
|
inlineoverridevirtual |
Returns TRUE if BVH tree is in invalidated state.
Reimplemented from Select3D_SensitiveEntity.
The documentation for this class was generated from the following file:
