// Copyright (c) 2021 OPEN CASCADE SAS // // This file is part of Open CASCADE Technology software library. // // This library is free software; you can redistribute it and/or modify it under // the terms of the GNU Lesser General Public License version 2.1 as published // by the Free Software Foundation, with special exception defined in the file // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT // distribution for complete text of the license and disclaimer of any warranty. // // Alternatively, this file may be used under the terms of Open CASCADE // commercial license or contractual agreement. #ifndef _SelectMgr_BaseIntersector_HeaderFile #define _SelectMgr_BaseIntersector_HeaderFile #include #include #include #include #include #include #include #include #include #include class Graphic3d_Camera; class SelectMgr_FrustumBuilder; class SelectMgr_ViewClipRange; //! 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 class SelectMgr_BaseIntersector : public Standard_Transient { public: //! Creates new empty selecting volume SelectMgr_BaseIntersector() : mySelectionType (SelectMgr_SelectionType_Unknown) {} //! Destructor virtual ~SelectMgr_BaseIntersector() {} //! Builds intersector according to internal parameters virtual void Build() {} //! Returns selection type of this intersector SelectMgr_SelectionType GetSelectionType() const { return mySelectionType; } public: //! Checks if it is possible to scale this intersector. //! @return false for the base class. virtual Standard_Boolean IsScalable() const { return Standard_False; } //! Sets pixel tolerance. //! It makes sense only for scalable intersectors (built on a single point). //! This method does nothing for the base class. Standard_EXPORT virtual void SetPixelTolerance (const Standard_Integer theTol); //! IMPORTANT: Scaling makes sense only for scalable intersectors (built on a single point)! //! Note that this method does not perform any checks on type of the frustum. //! Returns a copy of the frustum resized according to the scale factor given //! and transforms it using the matrix given. //! There are no default parameters, but in case if: //! - transformation only is needed: @theScaleFactor must be initialized as any negative value; //! - scale only is needed: @theTrsf must be set to gp_Identity. //! 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. //! This method does nothing for the base class. Standard_EXPORT virtual Handle(SelectMgr_BaseIntersector) ScaleAndTransform (const Standard_Integer theScaleFactor, const gp_GTrsf& theTrsf, const Handle(SelectMgr_FrustumBuilder)& theBuilder) const; public: //! Returns camera definition. //! This method returns empty camera for the base class. Standard_EXPORT virtual const Handle(Graphic3d_Camera)& Camera() const; //! Sets camera projection and orientation matrices. //! This method does nothing for the base class. Standard_EXPORT virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera); //! Sets camera projection and orientation matrices. //! This method does nothing for the base class. Standard_EXPORT virtual void SetCamera (const Graphic3d_Mat4d& theProjection, const Graphic3d_Mat4d& theWorldView, const Standard_Boolean theIsOrthographic, const Graphic3d_WorldViewProjState& theWVPState = Graphic3d_WorldViewProjState()); //! Returns current camera projection transformation. //! This method returns empty matrix for the base class. Standard_EXPORT virtual const Graphic3d_Mat4d& ProjectionMatrix() const; //! Returns current camera world view transformation. //! This method returns empty matrix for the base class. Standard_EXPORT virtual const Graphic3d_Mat4d& WorldViewMatrix() const; //! Returns current camera world view projection transformation state. //! This method returns empty matrix for the base class. Standard_EXPORT virtual const Graphic3d_WorldViewProjState& WorldViewProjState() const; //! Returns current window size. //! This method doesn't set any output values for the base class. Standard_EXPORT virtual void WindowSize (Standard_Integer& theWidth, Standard_Integer& theHeight) const; //! Sets current window size. //! This method does nothing for the base class. Standard_EXPORT virtual void SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight); //! Sets viewport parameters. //! This method does nothing for the base class. Standard_EXPORT virtual void SetViewport (const Standard_Real theX, const Standard_Real theY, const Standard_Real theWidth, const Standard_Real theHeight); //! Returns near point of intersector. //! This method returns zero point for the base class. Standard_EXPORT virtual const gp_Pnt& GetNearPnt() const; //! Returns far point of intersector. //! This method returns zero point for the base class. Standard_EXPORT virtual const gp_Pnt& GetFarPnt() const; //! Returns direction ray of intersector. //! This method returns zero direction for the base class. Standard_EXPORT virtual const gp_Dir& GetViewRayDirection() const; //! Returns current mouse coordinates. //! This method returns infinite point for the base class. Standard_EXPORT virtual const gp_Pnt2d& GetMousePosition() 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 void GetPlanes (NCollection_Vector& thePlaneEquations) const { thePlaneEquations.Clear(); } public: //! SAT intersection test between defined volume and given axis-aligned box Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin, const SelectMgr_Vec3& theBoxMax, const SelectMgr_ViewClipRange& theClipRange, SelectBasics_PickResult& thePickResult) const; //! Returns true if selecting volume is overlapped by axis-aligned bounding box //! with minimum corner at point theMinPt and maximum at point theMaxPt Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin, const SelectMgr_Vec3& theBoxMax, Standard_Boolean* theInside = NULL) const; //! Intersection test between defined volume and given point Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt, const SelectMgr_ViewClipRange& theClipRange, SelectBasics_PickResult& thePickResult) const; //! 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. Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt) const; //! 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 Standard_EXPORT virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt& theArrayOfPnts, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange& theClipRange, SelectBasics_PickResult& thePickResult) const; //! Checks if line segment overlaps selecting frustum Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1, const gp_Pnt& thePnt2, const SelectMgr_ViewClipRange& theClipRange, SelectBasics_PickResult& thePickResult) const; //! 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 Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePt1, const gp_Pnt& thePt2, const gp_Pnt& thePt3, Select3D_TypeOfSensitivity theSensType, const SelectMgr_ViewClipRange& theClipRange, SelectBasics_PickResult& thePickResult) const; public: //! 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. Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) 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. Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const; //! Dumps the content of me into the stream Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const; DEFINE_STANDARD_RTTIEXT(SelectMgr_BaseIntersector,Standard_Transient) protected: SelectMgr_SelectionType mySelectionType; }; #endif // _SelectMgr_BaseIntersector_HeaderFile