0032337: Visualization - rename Overlaps() method in selection to more self-describab...
[occt.git] / src / SelectMgr / SelectMgr_BaseIntersector.hxx
1 // Copyright (c) 2021 OPEN CASCADE SAS
2 //
3 // This file is part of Open CASCADE Technology software library.
4 //
5 // This library is free software; you can redistribute it and/or modify it under
6 // the terms of the GNU Lesser General Public License version 2.1 as published
7 // by the Free Software Foundation, with special exception defined in the file
8 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
9 // distribution for complete text of the license and disclaimer of any warranty.
10 //
11 // Alternatively, this file may be used under the terms of Open CASCADE
12 // commercial license or contractual agreement.
13
14 #ifndef _SelectMgr_BaseIntersector_HeaderFile
15 #define _SelectMgr_BaseIntersector_HeaderFile
16
17 #include <gp_GTrsf.hxx>
18 #include <Graphic3d_Mat4d.hxx>
19 #include <Graphic3d_WorldViewProjState.hxx>
20 #include <NCollection_Vector.hxx>
21 #include <Select3D_TypeOfSensitivity.hxx>
22 #include <SelectBasics_PickResult.hxx>
23 #include <SelectMgr_SelectionType.hxx>
24 #include <SelectMgr_VectorTypes.hxx>
25 #include <TColgp_Array1OfPnt2d.hxx>
26 #include <TColgp_Array1OfPnt.hxx>
27
28 class Graphic3d_Camera;
29 class SelectMgr_FrustumBuilder;
30 class SelectMgr_ViewClipRange;
31
32 //! This class is an interface for different types of selecting intersector,
33 //! defining different selection types, like point, box or polyline
34 //! selection. It contains signatures of functions for detection of
35 //! overlap by sensitive entity and initializes some data for building
36 //! the selecting intersector
37 class SelectMgr_BaseIntersector : public Standard_Transient
38 {
39 public:
40
41   //! Creates new empty selecting volume
42   SelectMgr_BaseIntersector()
43   : mySelectionType (SelectMgr_SelectionType_Unknown)
44   {}
45
46   //! Destructor
47   virtual ~SelectMgr_BaseIntersector() {}
48
49   //! Builds intersector according to internal parameters
50   virtual void Build() {}
51
52   //! Returns selection type of this intersector
53   SelectMgr_SelectionType GetSelectionType() const { return mySelectionType; }
54
55 public:
56
57   //! Checks if it is possible to scale this intersector.
58   //! @return false for the base class.
59   virtual Standard_Boolean IsScalable() const { return Standard_False; }
60
61   //! Sets pixel tolerance.
62   //! It makes sense only for scalable intersectors (built on a single point).
63   //! This method does nothing for the base class.
64   Standard_EXPORT virtual void SetPixelTolerance (const Standard_Integer theTol);
65
66   //! IMPORTANT: Scaling makes sense only for scalable intersectors (built on a single point)!
67   //!            Note that this method does not perform any checks on type of the frustum.
68   //! Returns a copy of the frustum resized according to the scale factor given
69   //! and transforms it using the matrix given.
70   //! There are no default parameters, but in case if:
71   //!    - transformation only is needed: @theScaleFactor must be initialized as any negative value;
72   //!    - scale only is needed: @theTrsf must be set to gp_Identity.
73   //! Builder is an optional argument that represents corresponding settings for re-constructing transformed
74   //! frustum from scratch. Can be null if reconstruction is not expected furthermore.
75   //! This method does nothing for the base class.
76   Standard_EXPORT virtual Handle(SelectMgr_BaseIntersector) ScaleAndTransform (const Standard_Integer theScaleFactor,
77                                                                                const gp_GTrsf& theTrsf,
78                                                                                const Handle(SelectMgr_FrustumBuilder)& theBuilder) const;
79
80 public:
81
82   //! Returns camera definition.
83   //! This method returns empty camera for the base class.
84   Standard_EXPORT virtual const Handle(Graphic3d_Camera)& Camera() const;
85
86   //! Sets camera projection and orientation matrices.
87   //! This method does nothing for the base class.
88   Standard_EXPORT virtual void SetCamera (const Handle(Graphic3d_Camera)& theCamera);
89
90   //! Sets camera projection and orientation matrices.
91   //! This method does nothing for the base class.
92   Standard_EXPORT virtual void SetCamera (const Graphic3d_Mat4d& theProjection,
93                                           const Graphic3d_Mat4d& theWorldView,
94                                           const Standard_Boolean theIsOrthographic,
95                                           const Graphic3d_WorldViewProjState& theWVPState = Graphic3d_WorldViewProjState());
96
97   //! Returns current camera projection transformation.
98   //! This method returns empty matrix for the base class.
99   Standard_EXPORT virtual const Graphic3d_Mat4d& ProjectionMatrix() const;
100
101   //! Returns current camera world view transformation.
102   //! This method returns empty matrix for the base class.
103   Standard_EXPORT virtual const Graphic3d_Mat4d& WorldViewMatrix() const;
104
105   //! Returns current camera world view projection transformation state.
106   //! This method returns empty matrix for the base class.
107   Standard_EXPORT virtual const Graphic3d_WorldViewProjState& WorldViewProjState() const;
108
109   //! Returns current window size.
110   //! This method doesn't set any output values for the base class.
111   Standard_EXPORT virtual void WindowSize (Standard_Integer& theWidth,
112                                            Standard_Integer& theHeight) const;
113
114   //! Sets current window size.
115   //! This method does nothing for the base class.
116   Standard_EXPORT virtual void SetWindowSize (const Standard_Integer theWidth,
117                                               const Standard_Integer theHeight);
118
119   //! Sets viewport parameters.
120   //! This method does nothing for the base class.
121   Standard_EXPORT virtual void SetViewport (const Standard_Real theX,
122                                             const Standard_Real theY,
123                                             const Standard_Real theWidth,
124                                             const Standard_Real theHeight);
125
126   //! Returns near point of intersector.
127   //! This method returns zero point for the base class.
128   Standard_EXPORT virtual const gp_Pnt& GetNearPnt() const;
129
130   //! Returns far point of intersector.
131   //! This method returns zero point for the base class.
132   Standard_EXPORT virtual const gp_Pnt& GetFarPnt() const;
133
134   //! Returns direction ray of intersector.
135   //! This method returns zero direction for the base class.
136   Standard_EXPORT virtual const gp_Dir& GetViewRayDirection() const;
137
138   //! Returns current mouse coordinates.
139   //! This method returns infinite point for the base class.
140   Standard_EXPORT virtual const gp_Pnt2d& GetMousePosition() const;
141
142   //! Stores plane equation coefficients (in the following form:
143   //! Ax + By + Cz + D = 0) to the given vector.
144   //! This method only clears input vector for the base class.
145   virtual void GetPlanes (NCollection_Vector<SelectMgr_Vec4>& thePlaneEquations) const
146   {
147     thePlaneEquations.Clear();
148   }
149
150 public:
151
152   //! SAT intersection test between defined volume and given axis-aligned box
153   Standard_EXPORT virtual Standard_Boolean OverlapsBox (const SelectMgr_Vec3& theBoxMin,
154                                                         const SelectMgr_Vec3& theBoxMax,
155                                                         const SelectMgr_ViewClipRange& theClipRange,
156                                                         SelectBasics_PickResult& thePickResult) const;
157
158   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
159   //! with minimum corner at point theMinPt and maximum at point theMaxPt
160   Standard_EXPORT virtual Standard_Boolean OverlapsBox (const SelectMgr_Vec3& theBoxMin,
161                                                         const SelectMgr_Vec3& theBoxMax,
162                                                         Standard_Boolean*     theInside = NULL) const;
163
164   //! Intersection test between defined volume and given point
165   Standard_EXPORT virtual Standard_Boolean OverlapsPoint (const gp_Pnt& thePnt,
166                                                           const SelectMgr_ViewClipRange& theClipRange,
167                                                           SelectBasics_PickResult& thePickResult) const;
168
169   //! Intersection test between defined volume and given point
170   //! Does not perform depth calculation, so this method is defined as
171   //! helper function for inclusion test. Therefore, its implementation
172   //! makes sense only for rectangular frustum with box selection mode activated.
173   Standard_EXPORT virtual Standard_Boolean OverlapsPoint (const gp_Pnt& thePnt) const;
174
175   //! SAT intersection test between defined volume and given ordered set of points,
176   //! representing line segments. The test may be considered of interior part or
177   //! boundary line defined by segments depending on given sensitivity type
178   Standard_EXPORT virtual Standard_Boolean OverlapsPolygon (const TColgp_Array1OfPnt& theArrayOfPnts,
179                                                             Select3D_TypeOfSensitivity theSensType,
180                                                             const SelectMgr_ViewClipRange& theClipRange,
181                                                             SelectBasics_PickResult& thePickResult) const;
182
183   //! Checks if line segment overlaps selecting frustum
184   Standard_EXPORT virtual Standard_Boolean OverlapsSegment (const gp_Pnt& thePnt1,
185                                                             const gp_Pnt& thePnt2,
186                                                             const SelectMgr_ViewClipRange& theClipRange,
187                                                             SelectBasics_PickResult& thePickResult) const;
188
189   //! SAT intersection test between defined volume and given triangle. The test may
190   //! be considered of interior part or boundary line defined by triangle vertices
191   //! depending on given sensitivity type
192   Standard_EXPORT virtual Standard_Boolean OverlapsTriangle (const gp_Pnt& thePt1,
193                                                              const gp_Pnt& thePt2,
194                                                              const gp_Pnt& thePt3,
195                                                              Select3D_TypeOfSensitivity theSensType,
196                                                              const SelectMgr_ViewClipRange& theClipRange,
197                                                              SelectBasics_PickResult& thePickResult) const;
198
199 public:
200
201   //! Measures distance between 3d projection of user-picked
202   //! screen point and given point theCOG.
203   //! It makes sense only for intersectors built on a single point.
204   //! This method returns infinite value for the base class.
205   Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) const;
206
207   //! Calculates the point on a view ray that was detected during the run of selection algo by given depth.
208   //! It makes sense only for intersectors built on a single point.
209   //! This method returns infinite point for the base class.
210   Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const;
211
212   //! Dumps the content of me into the stream
213   Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const;
214
215   DEFINE_STANDARD_RTTIEXT(SelectMgr_BaseIntersector,Standard_Transient)
216
217 protected:
218
219   SelectMgr_SelectionType mySelectionType;
220 };
221
222 #endif // _SelectMgr_BaseIntersector_HeaderFile