0029938: Visualization - SelectMgr_ViewerSelector::PickedPoint() should return point...
[occt.git] / src / SelectMgr / SelectMgr_TriangularFrustum.hxx
1 // Created on: 2014-05-22
2 // Created by: Varvara POSKONINA
3 // Copyright (c) 2005-2014 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _SelectMgr_TriangularFrustum_HeaderFile
17 #define _SelectMgr_TriangularFrustum_HeaderFile
18
19 #include <SelectMgr_Frustum.hxx>
20
21 //! This class contains representation of triangular selecting frustum, created in case
22 //! of polyline selection, and algorithms for overlap detection between selecting
23 //! frustum and sensitive entities.
24 //! Overlap detection tests are implemented according to the terms of separating axis
25 //! theorem (SAT).
26 class SelectMgr_TriangularFrustum : public SelectMgr_Frustum<3>
27 {
28 public:
29
30   //! Creates new triangular frustum with bases of triangles with vertices theP1,
31   //! theP2 and theP3 projections onto near and far view frustum planes
32   SelectMgr_TriangularFrustum() {};
33
34   Standard_EXPORT ~SelectMgr_TriangularFrustum();
35
36   //! Creates new triangular frustum with bases of triangles with vertices theP1, theP2 and theP3
37   //! projections onto near and far view frustum planes (only for triangular frustums)
38   Standard_EXPORT virtual void Build (const gp_Pnt2d& theP1,
39                                       const gp_Pnt2d& theP2,
40                                       const gp_Pnt2d& theP3) Standard_OVERRIDE;
41
42   //! Returns a copy of the frustum transformed according to the matrix given
43   Standard_EXPORT virtual Handle(SelectMgr_BaseFrustum) ScaleAndTransform (const Standard_Integer theScale,
44                                                                            const gp_GTrsf& theTrsf) const Standard_OVERRIDE;
45
46   // SAT Tests for different objects
47
48   //! SAT intersection test between defined volume and given axis-aligned box
49   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theMinPnt,
50                                                      const SelectMgr_Vec3& theMaxPnt,
51                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
52
53   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
54   //! with minimum corner at point theMinPt and maximum at point theMaxPt
55   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theMinPt,
56                                                      const SelectMgr_Vec3& theMaxPt,
57                                                      Standard_Boolean* theInside) Standard_OVERRIDE;
58
59   //! Intersection test between defined volume and given point
60   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
61                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
62
63   //! SAT intersection test between defined volume and given ordered set of points,
64   //! representing line segments. The test may be considered of interior part or
65   //! boundary line defined by segments depending on given sensitivity type
66   Standard_EXPORT virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt& theArrayOfPnts,
67                                                      Select3D_TypeOfSensitivity theSensType,
68                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
69
70   //! Checks if line segment overlaps selecting frustum
71   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
72                                                      const gp_Pnt& thePnt2,
73                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
74
75   //! SAT intersection test between defined volume and given triangle. The test may
76   //! be considered of interior part or boundary line defined by triangle vertices
77   //! depending on given sensitivity type
78   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
79                                                      const gp_Pnt& thePnt2,
80                                                      const gp_Pnt& thePnt3,
81                                                      Select3D_TypeOfSensitivity theSensType,
82                                                      SelectBasics_PickResult& thePickResult) Standard_OVERRIDE;
83
84   //! Nullifies the handle to corresponding builder instance to prevent memory leaks
85   Standard_EXPORT void Clear();
86
87   //! Stores plane equation coefficients (in the following form:
88   //! Ax + By + Cz + D = 0) to the given vector
89   Standard_EXPORT virtual void GetPlanes (NCollection_Vector<SelectMgr_Vec4>& thePlaneEquations) const Standard_OVERRIDE;
90
91 private:
92
93   void cacheVertexProjections (SelectMgr_TriangularFrustum* theFrustum) const;
94
95   DEFINE_STANDARD_RTTIEXT(SelectMgr_TriangularFrustum,SelectMgr_Frustum<3>)
96 };
97
98 #endif // _SelectMgr_TriangularFrustum_HeaderFile