Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
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.
 
 ~SelectMgr_AxisIntersector () override
 Destructor.
 
void Init (const gp_Ax1 &theAxis)
 Initializes selecting axis according to the input one.
 
void Build () override
 Builds axis according to internal parameters. NOTE: it should be called after Init() method.
 
void SetCamera (const occ::handle< Graphic3d_Camera > &theCamera) override
 Saves camera definition. Do nothing for axis intersector (not applicable to this volume).
 
bool IsScalable () const override
 Returns FALSE (not applicable to this volume).
 
occ::handle< SelectMgr_BaseIntersectorScaleAndTransform (const int theScaleFactor, const gp_GTrsf &theTrsf, const occ::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.
 
occ::handle< SelectMgr_BaseIntersectorCopyWithBuilder (const occ::handle< SelectMgr_FrustumBuilder > &theBuilder) const override
 Returns a copy of the intersector transformed using the builder configuration given. Builder is an argument that represents corresponding settings for re-constructing transformed frustum from scratch. In this class, builder is not used and theBuilder parameter is ignored.
 
bool OverlapsBox (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Intersection test between defined axis and given axis-aligned box.
 
bool OverlapsBox (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, bool *theInside) const override
 Returns true if selecting axis intersects axis-aligned bounding box with minimum corner at point theMinPt and maximum at point theMaxPt.
 
bool OverlapsPoint (const gp_Pnt &thePnt, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Intersection test between defined axis and given point.
 
bool OverlapsPoint (const gp_Pnt &thePnt) const override
 Intersection test between defined axis and given point.
 
bool OverlapsPolygon (const NCollection_Array1< gp_Pnt > &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.
 
bool 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.
 
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 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.
 
bool OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, bool *theInside=nullptr) const override
 Intersection test between defined axis and given sphere with center theCenter and radius theRadius.
 
bool OverlapsSphere (const gp_Pnt &theCenter, const double theRadius, const SelectMgr_ViewClipRange &theClipRange, SelectBasics_PickResult &thePickResult) const override
 Intersection test between defined axis and given sphere with center theCenter and radius theRadius.
 
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 override
 Returns true if selecting volume is overlapped by cylinder (or cone) with radiuses theBottomRad and theTopRad, height theHeight and transformation to apply theTrsf.
 
bool OverlapsCylinder (const double theBottomRad, const double theTopRad, const double theHeight, const gp_Trsf &theTrsf, const bool theIsHollow, bool *theInside=nullptr) 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.
 
bool OverlapsCircle (const double theRadius, const gp_Trsf &theTrsf, const bool 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().
 
bool OverlapsCircle (const double theRadius, const gp_Trsf &theTrsf, const bool theIsFilled, bool *theInside=nullptr) 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().
 
double DistToGeometryCenter (const gp_Pnt &theCOG) const override
 Measures distance between start axis point and given point theCOG.
 
gp_Pnt DetectedPoint (const double theDepth) const override
 Calculates the point on a axis ray that was detected during the run of selection algo by given depth.
 
const gp_PntGetNearPnt () const override
 Returns near point along axis.
 
const gp_PntGetFarPnt () const override
 Returns far point along axis (infinite).
 
const gp_DirGetViewRayDirection () const override
 Returns axis direction.
 
void DumpJson (Standard_OStream &theOStream, int 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.
 
 ~SelectMgr_BaseIntersector () override
 Destructor.
 
SelectMgr_SelectionType GetSelectionType () const
 Returns selection type of 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.
 
const occ::handle< Graphic3d_Camera > & Camera () const
 Return 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_Pnt2dGetMousePosition () 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 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_Transientoperator= (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_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.
 
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 Member Functions

bool hasIntersection (const NCollection_Vec3< double > &theBoxMin, const NCollection_Vec3< double > &theBoxMax, double &theTimeEnter, double &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.
 
bool hasIntersection (const gp_Pnt &thePnt, double &theDepth) const
 Returns true if selecting axis intersects point. Also returns time of axis-point intersection.
 
bool 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.
 
bool 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
occ::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()

SelectMgr_AxisIntersector::~SelectMgr_AxisIntersector ( )
override

Destructor.

Member Function Documentation

◆ Build()

void SelectMgr_AxisIntersector::Build ( )
overridevirtual

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

Implements SelectMgr_BaseIntersector.

◆ CopyWithBuilder()

occ::handle< SelectMgr_BaseIntersector > SelectMgr_AxisIntersector::CopyWithBuilder ( const occ::handle< SelectMgr_FrustumBuilder > & theBuilder) const
overridevirtual

Returns a copy of the intersector transformed using the builder configuration given. Builder is an argument that represents corresponding settings for re-constructing transformed frustum from scratch. In this class, builder is not used and theBuilder parameter is ignored.

Implements SelectMgr_BaseIntersector.

◆ DetectedPoint()

gp_Pnt SelectMgr_AxisIntersector::DetectedPoint ( const double 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()

double SelectMgr_AxisIntersector::DistToGeometryCenter ( const gp_Pnt & theCOG) const
overridevirtual

Measures distance between start axis point and given point theCOG.

Reimplemented from SelectMgr_BaseIntersector.

◆ DumpJson()

void SelectMgr_AxisIntersector::DumpJson ( Standard_OStream & theOStream,
int theDepth = -1 ) const
overridevirtual

Dumps the content of me into the stream.

Reimplemented from SelectMgr_BaseIntersector.

◆ GetFarPnt()

const gp_Pnt & SelectMgr_AxisIntersector::GetFarPnt ( ) const
overridevirtual

Returns far point along axis (infinite).

Reimplemented from SelectMgr_BaseIntersector.

◆ GetNearPnt()

const gp_Pnt & SelectMgr_AxisIntersector::GetNearPnt ( ) const
overridevirtual

Returns near point along axis.

Reimplemented from SelectMgr_BaseIntersector.

◆ GetViewRayDirection()

const gp_Dir & SelectMgr_AxisIntersector::GetViewRayDirection ( ) const
overridevirtual

Returns axis direction.

Reimplemented from SelectMgr_BaseIntersector.

◆ hasIntersection() [1/2]

bool SelectMgr_AxisIntersector::hasIntersection ( const gp_Pnt & thePnt,
double & theDepth ) const
protected

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

◆ hasIntersection() [2/2]

bool SelectMgr_AxisIntersector::hasIntersection ( const NCollection_Vec3< double > & theBoxMin,
const NCollection_Vec3< double > & theBoxMax,
double & theTimeEnter,
double & 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()

bool SelectMgr_AxisIntersector::IsScalable ( ) const
inlineoverridevirtual

Returns FALSE (not applicable to this volume).

Implements SelectMgr_BaseIntersector.

◆ OverlapsBox() [1/2]

bool SelectMgr_AxisIntersector::OverlapsBox ( const NCollection_Vec3< double > & theBoxMin,
const NCollection_Vec3< double > & theBoxMax,
bool * 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.

◆ OverlapsBox() [2/2]

bool SelectMgr_AxisIntersector::OverlapsBox ( const NCollection_Vec3< double > & theBoxMin,
const NCollection_Vec3< double > & theBoxMax,
const SelectMgr_ViewClipRange & theClipRange,
SelectBasics_PickResult & thePickResult ) const
overridevirtual

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

Implements SelectMgr_BaseIntersector.

◆ OverlapsCircle() [1/2]

bool SelectMgr_AxisIntersector::OverlapsCircle ( const double theRadius,
const gp_Trsf & theTrsf,
const bool theIsFilled,
bool * theInside = nullptr ) 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]

bool SelectMgr_AxisIntersector::OverlapsCircle ( const double theRadius,
const gp_Trsf & theTrsf,
const bool 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.

◆ OverlapsCylinder() [1/2]

bool SelectMgr_AxisIntersector::OverlapsCylinder ( const double theBottomRad,
const double theTopRad,
const double theHeight,
const gp_Trsf & theTrsf,
const bool theIsHollow,
bool * theInside = nullptr ) 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]

bool SelectMgr_AxisIntersector::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
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]

bool SelectMgr_AxisIntersector::OverlapsPoint ( const gp_Pnt & thePnt) const
overridevirtual

Intersection test between defined axis and given point.

Implements SelectMgr_BaseIntersector.

◆ OverlapsPoint() [2/2]

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

bool SelectMgr_AxisIntersector::OverlapsPolygon ( const NCollection_Array1< gp_Pnt > & 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()

bool 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]

bool SelectMgr_AxisIntersector::OverlapsSphere ( const gp_Pnt & theCenter,
const double theRadius,
bool * theInside = nullptr ) const
overridevirtual

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

Implements SelectMgr_BaseIntersector.

◆ OverlapsSphere() [2/2]

bool SelectMgr_AxisIntersector::OverlapsSphere ( const gp_Pnt & theCenter,
const double 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.

◆ OverlapsTriangle()

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

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

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

occ::handle< SelectMgr_BaseIntersector > SelectMgr_AxisIntersector::ScaleAndTransform ( const int theScaleFactor,
const gp_GTrsf & theTrsf,
const occ::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()

void SelectMgr_AxisIntersector::SetCamera ( const occ::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: