Open CASCADE Technology 7.8.0
Public Member Functions | Protected Member Functions
SelectMgr_AxisIntersector Class Reference

This class contains representation of selecting axis, created in case of point selection and algorithms for overlap detection between this axis and sensitive entities. More...

#include <SelectMgr_AxisIntersector.hxx>

Inheritance diagram for SelectMgr_AxisIntersector:
Inheritance graph
[legend]

Public Member Functions

 SelectMgr_AxisIntersector ()
 Empty constructor.
 
virtual ~SelectMgr_AxisIntersector ()
 Destructor.
 
void Init (const gp_Ax1 &theAxis)
 Initializes selecting axis according to the input one.
 
virtual void Build () override
 Builds axis according to internal parameters. NOTE: it should be called after Init() method.
 
virtual void SetCamera (const Handle< Graphic3d_Camera > &theCamera) override
 Saves camera definition. Do nothing for axis intersector (not applicable to this volume).
 
virtual Standard_Boolean IsScalable () const override
 Returns FALSE (not applicable to this volume).
 
virtual Handle< SelectMgr_BaseIntersectorScaleAndTransform (const Standard_Integer theScaleFactor, const gp_GTrsf &theTrsf, const Handle< SelectMgr_FrustumBuilder > &theBuilder) const override
 IMPORTANT: Scaling doesn't make sense for this intersector. Returns a copy of the intersector transformed using the matrix given. Builder is an optional argument that represents corresponding settings for re-constructing transformed frustum from scratch. Can be null if reconstruction is not expected furthermore.
 
virtual Standard_Boolean OverlapsBox (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Intersection test between defined axis and given axis-aligned box.
 
virtual Standard_Boolean OverlapsBox (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, Standard_Boolean *theInside) const override
 Returns true if selecting axis intersects 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 override
 Intersection test between defined axis and given point.
 
virtual Standard_Boolean OverlapsPoint (const gp_Pnt &thePnt) const override
 Intersection test between defined axis and given point.
 
virtual Standard_Boolean OverlapsPolygon (const TColgp_Array1OfPnt &theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Intersection test between defined axis 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 override
 Checks if selecting axis intersects line segment.
 
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 override
 Intersection test between defined axis 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 override
 Intersection test between defined axis and given 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 override
 Intersection test between defined axis and given 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 override
 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 override
 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 theRadius, const gp_Trsf &theTrsf, const Standard_Boolean theIsFilled, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 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 theRadius, const gp_Trsf &theTrsf, const Standard_Boolean theIsFilled, Standard_Boolean *theInside=NULL) const override
 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 override
 Measures distance between start axis point and given point theCOG.
 
virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const override
 Calculates the point on a axis ray that was detected during the run of selection algo by given depth.
 
virtual const gp_PntGetNearPnt () const override
 Returns near point along axis.
 
virtual const gp_PntGetFarPnt () const override
 Returns far point along axis (infinite).
 
virtual const gp_DirGetViewRayDirection () const override
 Returns axis direction.
 
virtual void DumpJson (Standard_OStream &theOStream, Standard_Integer theDepth=-1) const override
 Dumps the content of me into the stream.
 
- Public Member Functions inherited from SelectMgr_BaseIntersector
 SelectMgr_BaseIntersector ()
 Creates new empty selecting volume.
 
virtual ~SelectMgr_BaseIntersector ()
 Destructor.
 
SelectMgr_SelectionType GetSelectionType () const
 Returns selection type of 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.
 
const Handle< Graphic3d_Camera > & Camera () const
 Return 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_Pnt2dGetMousePosition () 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 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_Transientoperator= (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_TransientThis () 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 Member Functions

Standard_Boolean hasIntersection (const SelectMgr_Vec3 &theBoxMin, const SelectMgr_Vec3 &theBoxMax, Standard_Real &theTimeEnter, Standard_Real &theTimeLeave) const
 Returns true if selecting axis intersects axis-aligned bounding box with minimum corner at point theBoxMin and maximum at point theBoxMax. Also returns enter and leave time of axis-box intersection.
 
Standard_Boolean hasIntersection (const gp_Pnt &thePnt, Standard_Real &theDepth) const
 Returns true if selecting axis intersects point. Also returns time of axis-point intersection.
 
Standard_Boolean raySegmentDistance (const gp_Pnt &theSegPnt1, const gp_Pnt &theSegPnt2, SelectBasics_PickResult &thePickResult) const
 Returns true if selecting axis intersects segment. Also saves time of axis-segment intersection and intersection point as pick result.
 
Standard_Boolean rayPlaneIntersection (const gp_Vec &thePlane, const gp_Pnt &thePntOnPlane, SelectBasics_PickResult &thePickResult) const
 Returns true if selecting axis intersects plane. Also saves time of axis-plane intersection and intersection point as pick result.
 

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 charget_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.
 
- Protected Attributes inherited from SelectMgr_BaseIntersector
Handle< Graphic3d_CameramyCamera
 camera definition (if builder isn't NULL it is the same as its camera)
 
SelectMgr_SelectionType mySelectionType
 type of selection
 

Detailed Description

This class contains representation of selecting axis, created in case of point selection and algorithms for overlap detection between this axis and sensitive entities.

Constructor & Destructor Documentation

◆ SelectMgr_AxisIntersector()

SelectMgr_AxisIntersector::SelectMgr_AxisIntersector ( )

Empty constructor.

◆ ~SelectMgr_AxisIntersector()

virtual SelectMgr_AxisIntersector::~SelectMgr_AxisIntersector ( )
virtual

Destructor.

Member Function Documentation

◆ Build()

virtual void SelectMgr_AxisIntersector::Build ( )
overridevirtual

Builds axis according to internal parameters. NOTE: it should be called after Init() method.

Implements SelectMgr_BaseIntersector.

◆ DetectedPoint()

virtual gp_Pnt SelectMgr_AxisIntersector::DetectedPoint ( const Standard_Real  theDepth) const
overridevirtual

Calculates the point on a axis ray that was detected during the run of selection algo by given depth.

Reimplemented from SelectMgr_BaseIntersector.

◆ DistToGeometryCenter()

virtual Standard_Real SelectMgr_AxisIntersector::DistToGeometryCenter ( const gp_Pnt theCOG) const
overridevirtual

Measures distance between start axis point and given point theCOG.

Reimplemented from SelectMgr_BaseIntersector.

◆ DumpJson()

virtual void SelectMgr_AxisIntersector::DumpJson ( Standard_OStream theOStream,
Standard_Integer  theDepth = -1 
) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_BaseIntersector.

◆ GetFarPnt()

virtual const gp_Pnt & SelectMgr_AxisIntersector::GetFarPnt ( ) const
overridevirtual

Returns far point along axis (infinite).

Reimplemented from SelectMgr_BaseIntersector.

◆ GetNearPnt()

virtual const gp_Pnt & SelectMgr_AxisIntersector::GetNearPnt ( ) const
overridevirtual

Returns near point along axis.

Reimplemented from SelectMgr_BaseIntersector.

◆ GetViewRayDirection()

virtual const gp_Dir & SelectMgr_AxisIntersector::GetViewRayDirection ( ) const
overridevirtual

Returns axis direction.

Reimplemented from SelectMgr_BaseIntersector.

◆ hasIntersection() [1/2]

Standard_Boolean SelectMgr_AxisIntersector::hasIntersection ( const gp_Pnt thePnt,
Standard_Real theDepth 
) const
protected

Returns true if selecting axis intersects point. Also returns time of axis-point intersection.

◆ hasIntersection() [2/2]

Standard_Boolean SelectMgr_AxisIntersector::hasIntersection ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
Standard_Real theTimeEnter,
Standard_Real theTimeLeave 
) const
protected

Returns true if selecting axis intersects axis-aligned bounding box with minimum corner at point theBoxMin and maximum at point theBoxMax. Also returns enter and leave time of axis-box intersection.

◆ Init()

void SelectMgr_AxisIntersector::Init ( const gp_Ax1 theAxis)

Initializes selecting axis according to the input one.

◆ IsScalable()

virtual Standard_Boolean SelectMgr_AxisIntersector::IsScalable ( ) const
inlineoverridevirtual

Returns FALSE (not applicable to this volume).

Implements SelectMgr_BaseIntersector.

◆ OverlapsBox() [1/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsBox ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined axis and given axis-aligned box.

Implements SelectMgr_BaseIntersector.

◆ OverlapsBox() [2/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsBox ( const SelectMgr_Vec3 theBoxMin,
const SelectMgr_Vec3 theBoxMax,
Standard_Boolean theInside 
) const
overridevirtual

Returns true if selecting axis intersects axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt.

Implements SelectMgr_BaseIntersector.

◆ OverlapsCircle() [1/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsCircle ( const Standard_Real  theRadius,
const gp_Trsf theTrsf,
const Standard_Boolean  theIsFilled,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

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().

Implements SelectMgr_BaseIntersector.

◆ OverlapsCircle() [2/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsCircle ( const Standard_Real  theRadius,
const gp_Trsf theTrsf,
const Standard_Boolean  theIsFilled,
Standard_Boolean theInside = NULL 
) const
overridevirtual

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().

Implements SelectMgr_BaseIntersector.

◆ OverlapsCylinder() [1/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::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
overridevirtual

Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.

Implements SelectMgr_BaseIntersector.

◆ OverlapsCylinder() [2/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::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
overridevirtual

Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.

Implements SelectMgr_BaseIntersector.

◆ OverlapsPoint() [1/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsPoint ( const gp_Pnt thePnt) const
overridevirtual

Intersection test between defined axis and given point.

Implements SelectMgr_BaseIntersector.

◆ OverlapsPoint() [2/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsPoint ( const gp_Pnt thePnt,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined axis and given point.

Implements SelectMgr_BaseIntersector.

◆ OverlapsPolygon()

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsPolygon ( const TColgp_Array1OfPnt theArrayOfPnts,
Select3D_TypeOfSensitivity  theSensType,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined axis 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.

Implements SelectMgr_BaseIntersector.

◆ OverlapsSegment()

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsSegment ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Checks if selecting axis intersects line segment.

Implements SelectMgr_BaseIntersector.

◆ OverlapsSphere() [1/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsSphere ( const gp_Pnt theCenter,
const Standard_Real  theRadius,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined axis and given sphere with center theCenter and radius theRadius.

Implements SelectMgr_BaseIntersector.

◆ OverlapsSphere() [2/2]

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsSphere ( const gp_Pnt theCenter,
const Standard_Real  theRadius,
Standard_Boolean theInside = NULL 
) const
overridevirtual

Intersection test between defined axis and given sphere with center theCenter and radius theRadius.

Implements SelectMgr_BaseIntersector.

◆ OverlapsTriangle()

virtual Standard_Boolean SelectMgr_AxisIntersector::OverlapsTriangle ( const gp_Pnt thePnt1,
const gp_Pnt thePnt2,
const gp_Pnt thePnt3,
Select3D_TypeOfSensitivity  theSensType,
const SelectMgr_ViewClipRange theClipRange,
SelectBasics_PickResult thePickResult 
) const
overridevirtual

Intersection test between defined axis and given triangle. The test may be considered of interior part or boundary line defined by triangle vertices depending on given sensitivity type.

Implements SelectMgr_BaseIntersector.

◆ rayPlaneIntersection()

Standard_Boolean SelectMgr_AxisIntersector::rayPlaneIntersection ( const gp_Vec thePlane,
const gp_Pnt thePntOnPlane,
SelectBasics_PickResult thePickResult 
) const
protected

Returns true if selecting axis intersects plane. Also saves time of axis-plane intersection and intersection point as pick result.

◆ raySegmentDistance()

Standard_Boolean SelectMgr_AxisIntersector::raySegmentDistance ( const gp_Pnt theSegPnt1,
const gp_Pnt theSegPnt2,
SelectBasics_PickResult thePickResult 
) const
protected

Returns true if selecting axis intersects segment. Also saves time of axis-segment intersection and intersection point as pick result.

◆ ScaleAndTransform()

virtual Handle< SelectMgr_BaseIntersector > SelectMgr_AxisIntersector::ScaleAndTransform ( const Standard_Integer  theScaleFactor,
const gp_GTrsf theTrsf,
const Handle< SelectMgr_FrustumBuilder > &  theBuilder 
) const
overridevirtual

IMPORTANT: Scaling doesn't make sense for this intersector. Returns a copy of the intersector transformed using the matrix given. Builder is an optional argument that represents corresponding settings for re-constructing transformed frustum from scratch. Can be null if reconstruction is not expected furthermore.

Implements SelectMgr_BaseIntersector.

◆ SetCamera()

virtual void SelectMgr_AxisIntersector::SetCamera ( const Handle< Graphic3d_Camera > &  theCamera)
overridevirtual

Saves camera definition. Do nothing for axis intersector (not applicable to this volume).

Reimplemented from SelectMgr_BaseIntersector.


The documentation for this class was generated from the following file: