0026719: Visualization - cannot pick zoom persistent object
[occt.git] / src / SelectMgr / SelectMgr_RectangularFrustum.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_RectangularFrustum_HeaderFile
17 #define _SelectMgr_RectangularFrustum_HeaderFile
18
19 #include <SelectMgr_Frustum.hxx>
20
21 //! This class contains representation of rectangular selecting frustum, created in case
22 //! of point and box selection, and algorithms for overlap detection between selecting
23 //! frustum and sensitive entities. The principle of frustum calculation:
24 //! - for point selection: on a near view frustum plane rectangular neighborhood of
25 //!                        user-picked point is created according to the pixel tolerance
26 //!                        given and then this rectangle is projected onto far view frustum
27 //!                        plane. This rectangles define the parallel bases of selecting frustum;
28 //! - for box selection: box points are projected onto near and far view frustum planes.
29 //!                      These 2 projected rectangles define parallel bases of selecting frustum.
30 //! Overlap detection tests are implemented according to the terms of separating axis
31 //! theorem (SAT).
32 class SelectMgr_RectangularFrustum : public SelectMgr_Frustum<4>
33 {
34 public:
35
36   SelectMgr_RectangularFrustum() : myScale (1.0) {};
37
38   //! Builds volume according to the point and given pixel tolerance
39   Standard_EXPORT virtual void Build (const gp_Pnt2d& thePoint) Standard_OVERRIDE;
40
41   //! Builds volume according to the selected rectangle
42   Standard_EXPORT virtual void Build (const gp_Pnt2d& theMinPnt,
43                                       const gp_Pnt2d& theMaxPnt) Standard_OVERRIDE;
44
45   //! IMPORTANT: Scaling makes sense only for frustum built on a single point!
46   //!            Note that this method does not perform any checks on type of the frustum.
47   //! Returns a copy of the frustum resized according to the scale factor given
48   //! and transforms it using the matrix given.
49   //! There are no default parameters, but in case if:
50   //!    - transformation only is needed: @theScaleFactor must be initialized as any negative value;
51   //!    - scale only is needed: @theTrsf must be set to gp_Identity.
52   Standard_EXPORT virtual NCollection_Handle<SelectMgr_BaseFrustum> ScaleAndTransform (const Standard_Integer theScaleFactor,
53                                                                                        const gp_Trsf& theTrsf) Standard_OVERRIDE;
54
55
56   // SAT Tests for different objects
57
58   //! SAT intersection test between defined volume and given axis-aligned box
59   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
60                                                      const SelectMgr_Vec3& theBoxMax,
61                                                      Standard_Real& theDepth) Standard_OVERRIDE;
62
63   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
64   //! with minimum corner at point theMinPt and maximum at point theMaxPt
65   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
66                                                      const SelectMgr_Vec3& theBoxMax,
67                                                      Standard_Boolean*     theInside = NULL) Standard_OVERRIDE;
68
69   //! Intersection test between defined volume and given point
70   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
71                                                      Standard_Real& theDepth) Standard_OVERRIDE;
72
73   //! Intersection test between defined volume and given point
74   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt) Standard_OVERRIDE;
75
76   //! SAT intersection test between defined volume and given ordered set of points,
77   //! representing line segments. The test may be considered of interior part or
78   //! boundary line defined by segments depending on given sensitivity type
79   Standard_EXPORT virtual Standard_Boolean Overlaps (const Handle(TColgp_HArray1OfPnt)& theArrayOfPnts,
80                                                      Select3D_TypeOfSensitivity theSensType,
81                                                      Standard_Real& theDepth) Standard_OVERRIDE;
82
83   //! Checks if line segment overlaps selecting frustum
84   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
85                                                      const gp_Pnt& thePnt2,
86                                                      Standard_Real& theDepth) Standard_OVERRIDE;
87
88   //! SAT intersection test between defined volume and given triangle. The test may
89   //! be considered of interior part or boundary line defined by triangle vertices
90   //! depending on given sensitivity type
91   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
92                                                      const gp_Pnt& thePnt2,
93                                                      const gp_Pnt& thePnt3,
94                                                      Select3D_TypeOfSensitivity theSensType,
95                                                      Standard_Real& theDepth) Standard_OVERRIDE;
96
97   //! Measures distance between 3d projection of user-picked
98   //! screen point and given point theCOG
99   Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) Standard_OVERRIDE;
100
101   //! Calculates the point on a view ray that was detected during the run of selection algo by given depth
102   Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const Standard_OVERRIDE;
103
104   //! Checks if the point of sensitive in which selection was detected belongs
105   //! to the region defined by clipping planes
106   Standard_EXPORT virtual Standard_Boolean IsClipped (const Graphic3d_SequenceOfHClipPlane& thePlanes,
107                                                       const Standard_Real theDepth) Standard_OVERRIDE;
108
109   //! A set of helper functions that return rectangular selecting frustum data
110   inline const gp_Pnt* GetVertices() const { return myVertices; }
111
112   inline gp_Pnt GetNearPnt() const { return myNearPickedPnt; }
113
114   inline gp_Pnt GetFarPnt() const { return myFarPickedPnt; }
115 protected:
116
117   Standard_EXPORT void segmentSegmentDistance (const gp_Pnt& theSegPnt1,
118                                                const gp_Pnt& theSegPnt2,
119                                                Standard_Real& theDepth);
120
121   Standard_EXPORT void segmentPlaneIntersection (const gp_Vec& thePlane,
122                                                  const gp_Pnt& thePntOnPlane,
123                                                  Standard_Real& theDepth);
124
125 private:
126
127   void cacheVertexProjections (SelectMgr_RectangularFrustum* theFrustum);
128
129 private:
130   enum { LeftTopNear, LeftTopFar,
131          LeftBottomNear, LeftBottomFar,
132          RightTopNear, RightTopFar,
133          RightBottomNear, RightBottomFar };
134
135 private:
136
137   gp_Pnt   myNearPickedPnt;             //!< 3d projection of user-picked selection point onto near view plane
138   gp_Pnt   myFarPickedPnt;              //!< 3d projection of user-picked selection point onto far view plane
139   gp_Vec   myViewRayDir;
140   gp_Pnt2d myMousePos;                  //!< Mouse coordinates
141   Standard_Real myScale;                //!< Scale factor of applied transformation, if there was any
142 };
143
144 #endif // _SelectMgr_RectangularFrustum_HeaderFile