![]() |
Open CASCADE Technology Reference Manual 8.0.0
|
This class is an interface for different types of selecting intersector, defining different selection types, like point, box or polyline selection. It contains signatures of functions for detection of overlap by sensitive entity and initializes some data for building the selecting intersector. More...
#include <SelectMgr_BaseIntersector.hxx>

Public Member Functions | |
| SelectMgr_BaseIntersector () | |
| Creates new empty selecting volume. | |
| ~SelectMgr_BaseIntersector () override | |
| Destructor. | |
| virtual void | Build ()=0 |
| Builds intersector according to internal parameters. | |
| SelectMgr_SelectionType | GetSelectionType () const |
| Returns selection type of this intersector. | |
| virtual bool | IsScalable () const =0 |
| Checks if it is possible to scale this intersector. | |
| virtual void | SetPixelTolerance (const int theTol) |
| Sets pixel tolerance. It makes sense only for scalable intersectors (built on a single point). This method does nothing for the base class. | |
| virtual occ::handle< SelectMgr_BaseIntersector > | ScaleAndTransform (const int theScaleFactor, const gp_GTrsf &theTrsf, const occ::handle< SelectMgr_FrustumBuilder > &theBuilder) const =0 |
| Note that this method does not perform any checks on type of the frustum. | |
| virtual occ::handle< SelectMgr_BaseIntersector > | CopyWithBuilder (const occ::handle< SelectMgr_FrustumBuilder > &theBuilder) const =0 |
| const occ::handle< Graphic3d_Camera > & | Camera () const |
| Return camera definition. | |
| virtual void | SetCamera (const occ::handle< Graphic3d_Camera > &theCamera) |
| Saves camera definition. | |
| virtual void | WindowSize (int &theWidth, int &theHeight) const |
| Returns current window size. This method doesn't set any output values for the base class. | |
| virtual void | SetWindowSize (const int theWidth, const int theHeight) |
| Sets current window size. This method does nothing for the base class. | |
| virtual void | SetViewport (const double theX, const double theY, const double theWidth, const double theHeight) |
| Sets viewport parameters. This method does nothing for the base class. | |
| virtual const gp_Pnt & | GetNearPnt () const |
| Returns near point of intersector. This method returns zero point for the base class. | |
| virtual const gp_Pnt & | GetFarPnt () const |
| Returns far point of intersector. This method returns zero point for the base class. | |
| virtual const gp_Dir & | GetViewRayDirection () const |
| Returns direction ray of intersector. This method returns zero direction for the base class. | |
| virtual const gp_Pnt2d & | GetMousePosition () const |
| Returns current mouse coordinates. This method returns infinite point for the base class. | |
| virtual void | GetPlanes (NCollection_DynamicArray< NCollection_Vec4< double > > &thePlaneEquations) const |
| Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector. This method only clears input vector for the base class. | |
| virtual bool | OverlapsBox (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| SAT intersection test between defined volume and given axis-aligned box. | |
| virtual bool | OverlapsBox (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, bool *theInside=nullptr) const =0 |
| Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt. | |
| virtual bool | OverlapsPoint (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| Intersection test between defined volume and given point. | |
| virtual bool | OverlapsPoint (const gp_Pnt &thePnt) const =0 |
| Intersection test between defined volume and given point Does not perform depth calculation, so this method is defined as helper function for inclusion test. Therefore, its implementation makes sense only for rectangular frustum with box selection mode activated. | |
| virtual bool | OverlapsPolygon (const NCollection_Array1< gp_Pnt > &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| SAT intersection test between defined volume and given ordered set of points, representing line segments. The test may be considered of interior part or boundary line defined by segments depending on given sensitivity type. | |
| virtual bool | OverlapsSegment (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| Checks if line segment overlaps selecting frustum. | |
| virtual bool | OverlapsTriangle (const gp_Pnt &thePnt1, const gp_Pnt &thePnt2, const gp_Pnt &thePnt3, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| SAT intersection test between defined volume and given triangle. The test may be considered of interior part or boundary line defined by triangle vertices depending on given sensitivity type. | |
| virtual bool | OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, bool *theInside=nullptr) const =0 |
| Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius. | |
| virtual bool | OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius. | |
| virtual bool | OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf. | |
| virtual bool | OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, bool *theInside=nullptr) const =0 |
| Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf. | |
| virtual bool | OverlapsCircle (const double theBottomRad, const gp_Trsf &theTrsf, const bool theIsFilled, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin(). | |
| virtual bool | OverlapsCircle (const double theBottomRad, const gp_Trsf &theTrsf, const bool theIsFilled, bool *theInside=nullptr) const =0 |
| Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin(). | |
| virtual double | DistToGeometryCenter (const gp_Pnt &theCOG) const |
| Measures distance between 3d projection of user-picked screen point and given point theCOG. It makes sense only for intersectors built on a single point. This method returns infinite value for the base class. | |
| virtual gp_Pnt | DetectedPoint (const double theDepth) const |
| Calculates the point on a view ray that was detected during the run of selection algo by given depth. It makes sense only for intersectors built on a single point. This method returns infinite point for the base class. | |
| virtual void | DumpJson (Standard_OStream &theOStream, int theDepth=-1) const |
| Dumps the content of me into the stream. | |
| virtual bool | RaySphereIntersection (const gp_Pnt &theCenter, const double theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, double &theTimeEnter, double &theTimeLeave) const |
| Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the sphere with center at theCenter and radius TheRadius. | |
| virtual bool | RayCylinderIntersection (const double theBottomRadius, const double theTopRadius, const double theHeight, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const bool theIsHollow, double &theTimeEnter, double &theTimeLeave) const |
| Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the hollow cylinder (or cone) | |
| virtual bool | RayCircleIntersection (const double theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const bool theIsFilled, double &theTime) const |
| Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the circle. | |
Public Member Functions inherited from Standard_Transient | |
| Standard_Transient () | |
| Empty constructor. | |
| Standard_Transient (const Standard_Transient &) | |
| Copy constructor – does nothing. | |
| Standard_Transient & | operator= (const Standard_Transient &) |
| Assignment operator, needed to avoid copying reference counter. | |
| virtual | ~Standard_Transient ()=default |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| bool | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| bool | IsInstance (const char *const theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| bool | 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. | |
| bool | IsKind (const char *const 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. | |
| 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. | |
| int | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations. | |
| int | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Protected Attributes | |
| occ::handle< Graphic3d_Camera > | myCamera |
| camera definition (if builder isn't NULL it is the same as its camera) | |
| SelectMgr_SelectionType | mySelectionType |
| type of selection | |
Additional Inherited Members | |
Public Types inherited from Standard_Transient | |
| typedef void | base_type |
| Returns a type descriptor about this object. | |
Static Public Member Functions inherited from Standard_Transient | |
| static constexpr const char * | get_type_name () |
| Returns a type descriptor about this object. | |
| static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
| Returns type descriptor of Standard_Transient class. | |
This class is an interface for different types of selecting intersector, defining different selection types, like point, box or polyline selection. It contains signatures of functions for detection of overlap by sensitive entity and initializes some data for building the selecting intersector.
| SelectMgr_BaseIntersector::SelectMgr_BaseIntersector | ( | ) |
Creates new empty selecting volume.
|
override |
Destructor.
Builds intersector according to internal parameters.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
inline |
Return camera definition.
|
pure virtual |
| [in] | theBuilder | argument that represents corresponding settings for re-constructing transformed frustum from scratch; should NOT be NULL. |
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
Calculates the point on a view ray that was detected during the run of selection algo by given depth. It makes sense only for intersectors built on a single point. This method returns infinite point for the base class.
Reimplemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, and SelectMgr_TriangularFrustumSet.
|
virtual |
Measures distance between 3d projection of user-picked screen point and given point theCOG. It makes sense only for intersectors built on a single point. This method returns infinite value for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
|
virtual |
Dumps the content of me into the stream.
Reimplemented in SelectMgr_AxisIntersector, SelectMgr_BaseFrustum, SelectMgr_Frustum< N >, SelectMgr_Frustum< 3 >, SelectMgr_Frustum< 4 >, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
Returns far point of intersector. This method returns zero point for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
Returns current mouse coordinates. This method returns infinite point for the base class.
Reimplemented in SelectMgr_RectangularFrustum.
Returns near point of intersector. This method returns zero point for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
|
inlinevirtual |
Stores plane equation coefficients (in the following form: Ax + By + Cz + D = 0) to the given vector. This method only clears input vector for the base class.
Reimplemented in SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
inline |
Returns selection type of this intersector.
Returns direction ray of intersector. This method returns zero direction for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
Checks if it is possible to scale this intersector.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustumSet, and SelectMgr_TriangularFrustum.
|
pure virtual |
SAT intersection test between defined volume and given axis-aligned box.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin().
Implemented in SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustumSet, SelectMgr_AxisIntersector, and SelectMgr_TriangularFrustum.
|
pure virtual |
Returns true if selecting volume is overlapped by circle with radius theRadius, boolean theIsFilled and transformation to apply theTrsf. The position and orientation of the circle are specified via theTrsf transformation for gp::XOY() with center in gp::Origin().
Implemented in SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustumSet, SelectMgr_AxisIntersector, and SelectMgr_TriangularFrustum.
|
pure virtual |
Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
Intersection test between defined volume and given point Does not perform depth calculation, so this method is defined as helper function for inclusion test. Therefore, its implementation makes sense only for rectangular frustum with box selection mode activated.
Implemented in SelectMgr_TriangularFrustum, SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Intersection test between defined volume and given point.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
SAT intersection test between defined volume and given ordered set of points, representing line segments. The test may be considered of interior part or boundary line defined by segments depending on given sensitivity type.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Checks if line segment overlaps selecting frustum.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.
Implemented in SelectMgr_RectangularFrustum, SelectMgr_AxisIntersector, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
pure virtual |
SAT intersection test between defined volume and given triangle. The test may be considered of interior part or boundary line defined by triangle vertices depending on given sensitivity type.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
|
virtual |
Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the circle.
| [in] | theRadius | the circle radius |
| [in] | theLoc | the location of the ray |
| [in] | theRayDir | the ray direction |
| [in] | theIsFilled | true if it's a circle, false if it's a circle outline |
| [out] | theTime | the intersection |
|
virtual |
Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the hollow cylinder (or cone)
| [in] | theBottomRadius | the bottom cylinder radius |
| [in] | theTopRadius | the top cylinder radius |
| [in] | theHeight | the cylinder height |
| [in] | theLoc | the location of the ray |
| [in] | theRayDir | the ray direction |
| [in] | theIsHollow | true if the cylinder is hollow |
| [out] | theTimeEnter | the entering the intersection |
| [out] | theTimeLeave | the leaving the intersection |
|
virtual |
Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the sphere with center at theCenter and radius TheRadius.
|
pure virtual |
Note that this method does not perform any checks on type of the frustum.
| [in] | theScaleFactor | scale factor for new intersector or negative value if undefined; IMPORTANT: scaling makes sense only for scalable IsScalable() intersectors (built on a single point)! |
| [in] | theTrsf | transformation for new intersector or gp_Identity if undefined |
| [in] | theBuilder | an optional argument that represents corresponding settings for re-constructing transformed frustum from scratch; could be NULL if reconstruction is not expected furthermore |
Implemented in SelectMgr_TriangularFrustum, SelectMgr_TriangularFrustumSet, SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
|
virtual |
Saves camera definition.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_BaseFrustum.
Sets pixel tolerance. It makes sense only for scalable intersectors (built on a single point). This method does nothing for the base class.
Reimplemented in SelectMgr_BaseFrustum.
|
virtual |
Sets viewport parameters. This method does nothing for the base class.
Reimplemented in SelectMgr_BaseFrustum.
|
virtual |
Sets current window size. This method does nothing for the base class.
Reimplemented in SelectMgr_BaseFrustum.
|
virtual |
Returns current window size. This method doesn't set any output values for the base class.
Reimplemented in SelectMgr_BaseFrustum.
|
protected |
camera definition (if builder isn't NULL it is the same as its camera)
|
protected |
type of selection