A framework to define sensitive 3D arcs and circles. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly. More...
#include <Select3D_SensitiveCircle.hxx>
Inheritance diagram for Select3D_SensitiveCircle:
Public Member Functions | |
| Select3D_SensitiveCircle (const Handle< SelectMgr_EntityOwner > &theOwnerId, const gp_Circ &theCircle, const Standard_Boolean theIsFilled=Standard_False, const Standard_Integer theNbPnts=12) | |
| Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle, the boolean theIsFilled and the number of points theNbPnts. More... | |
| Select3D_SensitiveCircle (const Handle< SelectMgr_EntityOwner > &theOwnerId, const gp_Circ &theCircle, const Standard_Real theU1, const Standard_Real theU2, const Standard_Boolean theIsFilled=Standard_False, const Standard_Integer theNbPnts=12) | |
| Constructs the sensitive arc object defined by the owner theOwnerId, the circle theCircle, the parameters theU1 and theU2, the boolean theIsFilled and the number of points theNbPnts. theU1 and theU2 define the first and last points of the arc on theCircle. More... | |
| Select3D_SensitiveCircle (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Handle< TColgp_HArray1OfPnt > &thePnts3d, const Standard_Boolean theIsFilled=Standard_False) | |
| Constructs the sensitive circle object defined by the owner theOwnerId, the array of triangles thePnts3d, and the boolean theIsFilled. thePnts3d is an array of consecutive triangles on the circle. The triangle i+1 lies on the intersection of the tangents to the circle of i and i+2. Note, that the first point of thePnts3d must be equal to the last point of thePnts3d. More... | |
| Select3D_SensitiveCircle (const Handle< SelectMgr_EntityOwner > &theOwnerId, const TColgp_Array1OfPnt &thePnts3d, const Standard_Boolean theIsFilled=Standard_False) | |
| Constructs the sensitive circle object defined by the owner theOwnerId, the array of points thePnts3d, and the boolean theIsFilled. If the length of thePnts3d is more then 1, the first point of thePnts3d must be equal to the last point of thePnts3d. More... | |
| virtual Standard_Boolean | Matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult) override |
| Checks whether the circle 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 gp_Pnt | CenterOfGeometry () const override |
| Returns center of the circle. If location transformation is set, it will be applied. More... | |
| virtual void | BVH () override |
| Builds BVH tree for a circle's edge segments if needed. More... | |
| virtual Standard_Boolean | ToBuildBVH () const override |
| Returns TRUE if BVH tree is in invalidated state. More... | |
 Public Member Functions inherited from Select3D_SensitivePoly | |
| Select3D_SensitivePoly (const Handle< SelectMgr_EntityOwner > &theOwnerId, const TColgp_Array1OfPnt &thePoints, const Standard_Boolean theIsBVHEnabled) | |
| Constructs a sensitive face object defined by the owner OwnerId, the array of points ThePoints, and the sensitivity type Sensitivity. The array of points is the outer polygon of the geometric face. More... | |
| Select3D_SensitivePoly (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Handle< TColgp_HArray1OfPnt > &thePoints, const Standard_Boolean theIsBVHEnabled) | |
| Constructs a sensitive face object defined by the owner OwnerId, the array of points ThePoints, and the sensitivity type Sensitivity. The array of points is the outer polygon of the geometric face. More... | |
| Select3D_SensitivePoly (const Handle< SelectMgr_EntityOwner > &theOwnerId, const Standard_Boolean theIsBVHEnabled, const Standard_Integer theNbPnts=6) | |
| Constructs the sensitive circle object defined by the owner OwnerId, the circle Circle, the Boolean FilledCircle and the number of points NbOfPoints. More... | |
| virtual Standard_Integer | NbSubElements () const override |
| Returns the amount of segments in poly. More... | |
| void | Points3D (Handle< TColgp_HArray1OfPnt > &theHArrayOfPnt) |
| Returns the 3D points of the array used at construction time. More... | |
| void | ArrayBounds (Standard_Integer &theLow, Standard_Integer &theUp) const |
| Return array bounds. More... | |
| gp_Pnt | GetPoint3d (const Standard_Integer thePntIdx) const |
| Return point. More... | |
| virtual Select3D_BndBox3d | BoundingBox () override |
| Returns bounding box of a polygon. If location transformation is set, it will be applied. More... | |
| virtual Standard_Integer | Size () const override |
| Returns the amount of segments of the poly. More... | |
| virtual Select3D_BndBox3d | Box (const Standard_Integer theIdx) const override |
| Returns bounding box of segment 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 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_SensitiveSet | |
| Select3D_SensitiveSet (const Handle< SelectMgr_EntityOwner > &theOwnerId) | |
| Creates new empty sensitive set and its content. More... | |
| void | SetBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder) |
| Sets the method (builder) used to construct BVH. More... | |
| void | MarkDirty () |
| Marks BVH tree of the set as outdated. It will be rebuild at the next call of BVH() More... | |
| virtual void | Clear () override |
| Destroys cross-reference to avoid memory leak. More... | |
| Standard_Integer | GetLeafNodeSize () const |
| Returns a number of nodes in 1 BVH leaf. 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 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... | |
Protected Member Functions | |
| virtual Standard_Real | distanceToCOG (SelectBasics_SelectingVolumeManager &theMgr) override |
| Calculates distance from the 3d projection of used-picked screen point to center of the geometry. More... | |
| Protected Member Functions inherited from Select3D_SensitivePoly | |
| virtual Standard_Boolean | overlapsElement (SelectBasics_PickResult &thePickResult, SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside) override |
| Checks whether the segment with index theIdx overlaps the current selecting volume. More... | |
| virtual Standard_Boolean | elementIsInside (SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theElemIdx, Standard_Boolean theIsFullInside) override |
| Checks whether the entity with index theIdx is inside the current selecting volume. More... | |
| Protected Member Functions inherited from Select3D_SensitiveSet | |
| Standard_Boolean | matches (SelectBasics_SelectingVolumeManager &theMgr, SelectBasics_PickResult &thePickResult, Standard_Boolean theToCheckAllInside) |
| Checks whether one or more entities of the set overlap current selecting volume. Implements the traverse of BVH tree built for the set. More... | |
| Standard_Boolean | processElements (SelectBasics_SelectingVolumeManager &theMgr, Standard_Integer theFirstElem, Standard_Integer theLastElem, Standard_Boolean theIsFullInside, Standard_Boolean theToCheckAllInside, SelectBasics_PickResult &thePickResult, Standard_Integer &theMatchesNb) |
| Process elements overlapped by the selection volume. More... | |
| Protected Member Functions inherited from Select3D_SensitiveEntity | |
| Select3D_SensitiveEntity (const Handle< SelectMgr_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 Select3D_SensitiveSet | |
| static const Handle< Select3D_BVHBuilder3d > & | DefaultBVHBuilder () |
| Return global instance to default BVH builder. More... | |
| static void | SetDefaultBVHBuilder (const Handle< Select3D_BVHBuilder3d > &theBuilder) |
| Assign new BVH builder to be used by default for new sensitive sets (assigning is NOT thread-safe!). 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 Select3D_SensitivePoly | |
| Select3D_PointData | myPolyg |
| Points of the poly. More... | |
| gp_Pnt | myCOG |
| Center of the poly. More... | |
| Handle< TColStd_HArray1OfInteger > | mySegmentIndexes |
| Segment indexes for BVH tree build. More... | |
| Select3D_BndBox3d | myBndBox |
| Bounding box of the poly. More... | |
| Standard_Boolean | myIsComputed |
| Is true if all the points and data structures of polygon are initialized. More... | |
| Protected Attributes inherited from Select3D_SensitiveSet | |
| BvhPrimitiveSet | myContent |
| A link between sensitive entity and BVH_PrimitiveSet. More... | |
| Standard_Integer | myDetectedIdx |
| Index of detected primitive in BVH sorted primitive array. More... | |
| Protected Attributes inherited from Select3D_SensitiveEntity | |
| Handle< SelectMgr_EntityOwner > | myOwnerId |
| Standard_Integer | mySFactor |
Detailed Description
A framework to define sensitive 3D arcs and circles. In some cases this class can raise Standard_ConstructionError and Standard_OutOfRange exceptions. For more details see Select3D_SensitivePoly.
Constructor & Destructor Documentation
◆ Select3D_SensitiveCircle() [1/4]
| Select3D_SensitiveCircle::Select3D_SensitiveCircle | ( | const Handle< SelectMgr_EntityOwner > & | theOwnerId, |
| const gp_Circ & | theCircle, | ||
| const Standard_Boolean | theIsFilled = Standard_False, |
||
| const Standard_Integer | theNbPnts = 12 |
||
| ) |
Constructs the sensitive circle object defined by the owner theOwnerId, the circle theCircle, the boolean theIsFilled and the number of points theNbPnts.
◆ Select3D_SensitiveCircle() [2/4]
| Select3D_SensitiveCircle::Select3D_SensitiveCircle | ( | const Handle< SelectMgr_EntityOwner > & | theOwnerId, |
| const gp_Circ & | theCircle, | ||
| const Standard_Real | theU1, | ||
| const Standard_Real | theU2, | ||
| const Standard_Boolean | theIsFilled = Standard_False, |
||
| const Standard_Integer | theNbPnts = 12 |
||
| ) |
Constructs the sensitive arc object defined by the owner theOwnerId, the circle theCircle, the parameters theU1 and theU2, the boolean theIsFilled and the number of points theNbPnts. theU1 and theU2 define the first and last points of the arc on theCircle.
◆ Select3D_SensitiveCircle() [3/4]
| Select3D_SensitiveCircle::Select3D_SensitiveCircle | ( | const Handle< SelectMgr_EntityOwner > & | theOwnerId, |
| const Handle< TColgp_HArray1OfPnt > & | thePnts3d, | ||
| const Standard_Boolean | theIsFilled = Standard_False |
||
| ) |
Constructs the sensitive circle object defined by the owner theOwnerId, the array of triangles thePnts3d, and the boolean theIsFilled. thePnts3d is an array of consecutive triangles on the circle. The triangle i+1 lies on the intersection of the tangents to the circle of i and i+2. Note, that the first point of thePnts3d must be equal to the last point of thePnts3d.
◆ Select3D_SensitiveCircle() [4/4]
| Select3D_SensitiveCircle::Select3D_SensitiveCircle | ( | const Handle< SelectMgr_EntityOwner > & | theOwnerId, |
| const TColgp_Array1OfPnt & | thePnts3d, | ||
| const Standard_Boolean | theIsFilled = Standard_False |
||
| ) |
Constructs the sensitive circle object defined by the owner theOwnerId, the array of points thePnts3d, and the boolean theIsFilled. If the length of thePnts3d is more then 1, the first point of thePnts3d must be equal to the last point of thePnts3d.
Member Function Documentation
◆ BVH()
|
overridevirtual |
Builds BVH tree for a circle's edge segments if needed.
Reimplemented from Select3D_SensitiveSet.
◆ CenterOfGeometry()
|
overridevirtual |
Returns center of the circle. If location transformation is set, it will be applied.
Reimplemented from Select3D_SensitivePoly.
◆ distanceToCOG()
|
overrideprotectedvirtual |
Calculates distance from the 3d projection of used-picked screen point to center of the geometry.
Reimplemented from Select3D_SensitivePoly.
◆ 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.
◆ Matches()
|
overridevirtual |
Checks whether the circle overlaps current selecting volume.
Reimplemented from Select3D_SensitiveSet.
◆ ToBuildBVH()
|
overridevirtual |
Returns TRUE if BVH tree is in invalidated state.
Reimplemented from Select3D_SensitiveSet.
The documentation for this class was generated from the following file:
