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. | |
| virtual | ~SelectMgr_BaseIntersector () |
| Destructor. | |
| virtual void | Build ()=0 |
| Builds intersector according to internal parameters. | |
| SelectMgr_SelectionType | GetSelectionType () const |
| Returns selection type of this intersector. | |
| virtual Standard_Boolean | IsScalable () const =0 |
| Checks if it is possible to scale this intersector. | |
| virtual void | SetPixelTolerance (const Standard_Integer 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 Handle< SelectMgr_BaseIntersector > | ScaleAndTransform (const Standard_Integer theScaleFactor, const gp_GTrsf &theTrsf, const Handle< SelectMgr_FrustumBuilder > &theBuilder) const =0 |
| Note that this method does not perform any checks on type of the frustum. | |
| virtual Handle< SelectMgr_BaseIntersector > | CopyWithBuilder (const Handle< SelectMgr_FrustumBuilder > &theBuilder) const =0 |
| const Handle< Graphic3d_Camera > & | Camera () const |
| Return camera definition. | |
| virtual void | SetCamera (const Handle< Graphic3d_Camera > &theCamera) |
| Saves camera definition. | |
| virtual void | WindowSize (Standard_Integer &theWidth, Standard_Integer &theHeight) const |
| Returns current window size. This method doesn't set any output values for the base class. | |
| virtual void | SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight) |
| Sets current window size. This method does nothing for the base class. | |
| virtual void | SetViewport (const Standard_Real theX, const Standard_Real theY, const Standard_Real theWidth, const Standard_Real 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_Vector< SelectMgr_Vec4 > &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 Standard_Boolean | OverlapsBox (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| SAT intersection test between defined volume and given axis-aligned box. | |
| virtual Standard_Boolean | OverlapsBox (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, Standard_Boolean *theInside=NULL) 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 Standard_Boolean | OverlapsPoint (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const =0 |
| Intersection test between defined volume and given point. | |
| virtual Standard_Boolean | 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 Standard_Boolean | OverlapsPolygon (const TColgp_Array1OfPnt &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 Standard_Boolean | 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 Standard_Boolean | 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 Standard_Boolean | OverlapsSphere (const gp_Pnt &theCenter, const Standard_Real theRadius, Standard_Boolean *theInside=NULL) const =0 |
| Returns true if selecting volume is overlapped by sphere with center theCenter and radius theRadius. | |
| virtual Standard_Boolean | OverlapsSphere (const gp_Pnt &theCenter, const Standard_Real 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 Standard_Boolean | OverlapsCylinder (const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, const Standard_Boolean 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 Standard_Boolean | OverlapsCylinder (const Standard_Real theBottomRad, const Standard_Real theTopRad, const Standard_Real theHeight, const gp_Trsf &theTrsf, const Standard_Boolean theIsHollow, Standard_Boolean *theInside=NULL) 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 Standard_Boolean | OverlapsCircle (const Standard_Real theBottomRad, const gp_Trsf &theTrsf, const Standard_Boolean 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 Standard_Boolean | OverlapsCircle (const Standard_Real theBottomRad, const gp_Trsf &theTrsf, const Standard_Boolean theIsFilled, Standard_Boolean *theInside=NULL) 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 Standard_Real | 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 Standard_Real 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, Standard_Integer theDepth=-1) const |
| Dumps the content of me into the stream. | |
| virtual Standard_Boolean | RaySphereIntersection (const gp_Pnt &theCenter, const Standard_Real theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, Standard_Real &theTimeEnter, Standard_Real &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 Standard_Boolean | RayCylinderIntersection (const Standard_Real theBottomRadius, const Standard_Real theTopRadius, const Standard_Real theHeight, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const Standard_Boolean theIsHollow, Standard_Real &theTimeEnter, Standard_Real &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 Standard_Boolean | RayCircleIntersection (const Standard_Real theRadius, const gp_Pnt &theLoc, const gp_Dir &theRayDir, const Standard_Boolean theIsFilled, Standard_Real &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 () |
| Destructor must be virtual. | |
| virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
| Returns a type descriptor about this object. | |
| Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
| Returns a true value if this is an instance of Type. | |
| Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
| Returns a true value if this is an instance of TypeName. | |
| 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. | |
| 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. | |
| 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. | |
| Standard_Integer | GetRefCount () const noexcept |
| Get the reference counter of this object. | |
| void | IncrementRefCounter () noexcept |
| Increments the reference counter of this object. | |
| Standard_Integer | DecrementRefCounter () noexcept |
| Decrements the reference counter of this object; returns the decremented value. | |
| virtual void | Delete () const |
| Memory deallocator for transient classes. | |
Protected Attributes | |
| 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. | |
Detailed Description
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.
Constructor & Destructor Documentation
◆ SelectMgr_BaseIntersector()
| SelectMgr_BaseIntersector::SelectMgr_BaseIntersector | ( | ) |
Creates new empty selecting volume.
◆ ~SelectMgr_BaseIntersector()
|
virtual |
Destructor.
Member Function Documentation
◆ Build()
|
pure virtual |
Builds intersector according to internal parameters.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ Camera()
|
inline |
Return camera definition.
◆ CopyWithBuilder()
|
pure virtual |
- Parameters
-
theBuilder [in] argument that represents corresponding settings for re-constructing transformed frustum from scratch; should NOT be NULL.
- Returns
- a copy of the frustum with the input builder assigned
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ DetectedPoint()
|
virtual |
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.
◆ DistToGeometryCenter()
|
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.
◆ DumpJson()
|
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.
◆ GetFarPnt()
|
virtual |
Returns far point of intersector. This method returns zero point for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
◆ GetMousePosition()
|
virtual |
Returns current mouse coordinates. This method returns infinite point for the base class.
Reimplemented in SelectMgr_RectangularFrustum.
◆ GetNearPnt()
|
virtual |
Returns near point of intersector. This method returns zero point for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
◆ GetPlanes()
|
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.
◆ GetSelectionType()
|
inline |
Returns selection type of this intersector.
◆ GetViewRayDirection()
|
virtual |
Returns direction ray of intersector. This method returns zero direction for the base class.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_RectangularFrustum.
◆ IsScalable()
|
pure virtual |
Checks if it is possible to scale this intersector.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsBox() [1/2]
|
pure virtual |
SAT intersection test between defined volume and given axis-aligned box.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsBox() [2/2]
|
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_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsCircle() [1/2]
|
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_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsCircle() [2/2]
|
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_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsCylinder() [1/2]
|
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.
◆ OverlapsCylinder() [2/2]
|
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.
◆ OverlapsPoint() [1/2]
|
pure virtual |
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_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsPoint() [2/2]
|
pure virtual |
Intersection test between defined volume and given point.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsPolygon()
|
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.
◆ OverlapsSegment()
|
pure virtual |
Checks if line segment overlaps selecting frustum.
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ OverlapsSphere() [1/2]
|
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.
◆ OverlapsSphere() [2/2]
|
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.
◆ OverlapsTriangle()
|
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.
◆ RayCircleIntersection()
|
virtual |
Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the circle.
- Parameters
-
[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
◆ RayCylinderIntersection()
|
virtual |
Checks whether the ray that starts at the point theLoc and directs with the direction theRayDir intersects with the hollow cylinder (or cone)
- Parameters
-
[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
◆ RaySphereIntersection()
|
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.
◆ ScaleAndTransform()
|
pure virtual |
Note that this method does not perform any checks on type of the frustum.
- Parameters
-
theScaleFactor [in] scale factor for new intersector or negative value if undefined; IMPORTANT: scaling makes sense only for scalable IsScalable() intersectors (built on a single point)! theTrsf [in] transformation for new intersector or gp_Identity if undefined theBuilder [in] an optional argument that represents corresponding settings for re-constructing transformed frustum from scratch; could be NULL if reconstruction is not expected furthermore
- Returns
- a copy of the frustum resized according to the scale factor given and transforms it using the matrix given
Implemented in SelectMgr_AxisIntersector, SelectMgr_RectangularFrustum, SelectMgr_TriangularFrustum, and SelectMgr_TriangularFrustumSet.
◆ SetCamera()
|
virtual |
Saves camera definition.
Reimplemented in SelectMgr_AxisIntersector, and SelectMgr_BaseFrustum.
◆ SetPixelTolerance()
|
virtual |
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.
◆ SetViewport()
|
virtual |
Sets viewport parameters. This method does nothing for the base class.
Reimplemented in SelectMgr_BaseFrustum.
◆ SetWindowSize()
|
virtual |
Sets current window size. This method does nothing for the base class.
Reimplemented in SelectMgr_BaseFrustum.
◆ WindowSize()
|
virtual |
Returns current window size. This method doesn't set any output values for the base class.
Reimplemented in SelectMgr_BaseFrustum.
Field Documentation
◆ myCamera
|
protected |
camera definition (if builder isn't NULL it is the same as its camera)
◆ mySelectionType
|
protected |
type of selection
The documentation for this class was generated from the following file:
Generated by
1.12.0