Abstract framework to define 3D sensitive entities. As the selection process uses the principle of a projection of 3D shapes onto a 2D view where nearness to a rectangle determines whether a shape is picked or not, all 3D shapes need to be converted into 2D ones in order to be selected. More...
#include <Select3D_SensitiveEntity.hxx>
Public Member Functions | |
| virtual Handle< Select3D_SensitiveEntity > | GetConnected () |
| 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... | |
| virtual Standard_Boolean | Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override |
| Checks whether sensitive overlaps current selecting volume. Stores minimum depth, distance to center of geometry and closest point detected into thePickResult. More... | |
| virtual Standard_Integer | NbSubElements () override=0 |
| Returns the number of sub-entities or elements in sensitive entity. Is used to determine if entity is complex and needs to pre-build BVH at the creation of sensitive entity step or is light-weighted so the tree can be build on demand with unnoticeable delay. More... | |
| virtual Select3D_BndBox3d | BoundingBox () override=0 |
| Returns bounding box of a sensitive with transformation applied. More... | |
| virtual gp_Pnt | CenterOfGeometry () const =0 |
| Returns center of a sensitive with transformation applied. More... | |
| virtual void | BVH () override |
| Builds BVH tree for a sensitive if needed. More... | |
| virtual void | Clear () override |
| Clears up all resources and memory. More... | |
| virtual Standard_Boolean | HasInitLocation () const override |
| Returns true if the shape corresponding to the entity has init location. More... | |
| virtual gp_GTrsf | 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 | |
| virtual void | Set (const Handle< SelectBasics_EntityOwner > &theOwnerId) |
| Sets owner of the entity. More... | |
| 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 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... | |
Protected Member Functions | |
| Select3D_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId) | |
| Protected Member Functions inherited from SelectBasics_SensitiveEntity | |
| SelectBasics_SensitiveEntity (const Handle< SelectBasics_EntityOwner > &theOwnerId) | |
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 Attributes inherited from SelectBasics_SensitiveEntity | |
| Handle< SelectBasics_EntityOwner > | myOwnerId |
| Standard_Integer | mySFactor |
Detailed Description
Abstract framework to define 3D sensitive entities. As the selection process uses the principle of a projection of 3D shapes onto a 2D view where nearness to a rectangle determines whether a shape is picked or not, all 3D shapes need to be converted into 2D ones in order to be selected.
Constructor & Destructor Documentation
◆ Select3D_SensitiveEntity()
|
protected |
Member Function Documentation
◆ BoundingBox()
|
overridepure virtual |
Returns bounding box of a sensitive with transformation applied.
Implements SelectBasics_SensitiveEntity.
Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveSet, Select3D_SensitiveTriangulation, Select3D_SensitivePoly, Select3D_SensitiveBox, Select3D_InteriorSensitivePointSet, Select3D_SensitiveFace, Select3D_SensitiveSegment, Select3D_SensitiveTriangle, MeshVS_SensitivePolyhedron, MeshVS_SensitiveQuad, MeshVS_CommonSensitiveEntity, Select3D_SensitivePoint, Select3D_SensitiveWire, and MeshVS_SensitiveMesh.
◆ BVH()
|
overridevirtual |
Builds BVH tree for a sensitive if needed.
Implements SelectBasics_SensitiveEntity.
Reimplemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveCircle, Select3D_SensitiveSet, and Select3D_SensitiveFace.
◆ CenterOfGeometry()
|
pure virtual |
Returns center of a sensitive with transformation applied.
Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveSet, Select3D_SensitiveCircle, Select3D_SensitiveTriangulation, Select3D_SensitivePoly, Select3D_InteriorSensitivePointSet, Select3D_SensitiveFace, Select3D_SensitiveTriangle, Select3D_SensitiveBox, MeshVS_SensitivePolyhedron, Select3D_SensitiveSegment, MeshVS_CommonSensitiveEntity, Select3D_SensitiveWire, MeshVS_SensitiveQuad, MeshVS_SensitiveMesh, and Select3D_SensitivePoint.
◆ Clear()
|
overridevirtual |
Clears up all resources and memory.
Implements SelectBasics_SensitiveEntity.
Reimplemented in Select3D_SensitiveSet, and Select3D_SensitiveGroup.
◆ GetConnected()
|
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 in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveCircle, Select3D_SensitiveFace, Select3D_SensitiveTriangulation, Select3D_SensitiveTriangle, Select3D_SensitiveCurve, MeshVS_SensitivePolyhedron, Select3D_SensitiveSegment, Select3D_SensitiveBox, MeshVS_SensitiveQuad, MeshVS_SensitiveMesh, Select3D_SensitiveWire, and Select3D_SensitivePoint.
◆ HasInitLocation()
|
overridevirtual |
Returns true if the shape corresponding to the entity has init location.
Implements SelectBasics_SensitiveEntity.
Reimplemented in Select3D_SensitivePrimitiveArray, and Select3D_SensitiveTriangulation.
◆ InvInitLocation()
|
overridevirtual |
Returns inversed location transformation matrix if the shape corresponding to this entity has init location set. Otherwise, returns identity matrix.
Implements SelectBasics_SensitiveEntity.
Reimplemented in Select3D_SensitivePrimitiveArray, and Select3D_SensitiveTriangulation.
◆ Matches()
|
overridevirtual |
Checks whether sensitive overlaps current selecting volume. Stores minimum depth, distance to center of geometry and closest point detected into thePickResult.
Implements SelectBasics_SensitiveEntity.
Reimplemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveCircle, Select3D_SensitiveSet, Select3D_SensitiveFace, MeshVS_SensitivePolyhedron, Select3D_SensitiveSegment, Select3D_SensitiveBox, MeshVS_SensitiveQuad, Select3D_SensitiveTriangle, and Select3D_SensitivePoint.
◆ NbSubElements()
|
overridepure virtual |
Returns the number of sub-entities or elements in sensitive entity. Is used to determine if entity is complex and needs to pre-build BVH at the creation of sensitive entity step or is light-weighted so the tree can be build on demand with unnoticeable delay.
Implements SelectBasics_SensitiveEntity.
Implemented in Select3D_SensitivePrimitiveArray, Select3D_SensitiveGroup, Select3D_SensitiveFace, Select3D_InteriorSensitivePointSet, Select3D_SensitiveTriangle, Select3D_SensitivePoly, MeshVS_SensitivePolyhedron, Select3D_SensitiveTriangulation, Select3D_SensitiveSegment, Select3D_SensitiveBox, MeshVS_SensitiveMesh, MeshVS_SensitiveQuad, MeshVS_CommonSensitiveEntity, Select3D_SensitiveWire, and Select3D_SensitivePoint.
The documentation for this class was generated from the following file:
