0027969: Visualization - add interfaces to access selecting volumes from SelectMgr_Se...
[occt.git] / src / SelectMgr / SelectMgr_BaseFrustum.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_BaseFrustum_HeaderFile
17 #define _SelectMgr_BaseFrustum_HeaderFile
18
19 #include <gp_GTrsf.hxx>
20 #include <gp_Pnt.hxx>
21 #include <gp_Pln.hxx>
22
23 #include <Graphic3d_Camera.hxx>
24 #include <Graphic3d_ClipPlane.hxx>
25 #include <Graphic3d_SequenceOfHClipPlane.hxx>
26 #include <Graphic3d_WorldViewProjState.hxx>
27
28 #include <TColgp_HArray1OfPnt.hxx>
29 #include <TColgp_Array1OfPnt2d.hxx>
30
31 #include <Select3D_BndBox3d.hxx>
32 #include <SelectMgr_FrustumBuilder.hxx>
33 #include <Select3D_TypeOfSensitivity.hxx>
34 #include <SelectMgr_VectorTypes.hxx>
35
36 //! This class is an interface for different types of selecting frustums,
37 //! defining different selection types, like point, box or polyline
38 //! selection. It contains signatures of functions for detection of
39 //! overlap by sensitive entity and initializes some data for building
40 //! the selecting frustum
41 class SelectMgr_BaseFrustum : public Standard_Transient
42 {
43 public:
44
45   //! Creates new selecting volume with pixel toletance set to 2,
46   //! orthographic camera and empty frustum builder
47   Standard_EXPORT SelectMgr_BaseFrustum();
48
49   virtual ~SelectMgr_BaseFrustum() {}
50
51   //! Return camera definition.
52   const Handle(Graphic3d_Camera)& Camera() const { return myCamera; }
53
54   //! Passes camera projection and orientation matrices to builder
55   Standard_EXPORT void SetCamera (const Handle(Graphic3d_Camera)& theCamera);
56
57   //! Passes camera projection and orientation matrices to builder
58   Standard_EXPORT void SetCamera (const Graphic3d_Mat4d& theProjection,
59                                   const Graphic3d_Mat4d& theWorldView,
60                                   const Standard_Boolean theIsOrthographic,
61                                   const Graphic3d_WorldViewProjState& theWVPState = Graphic3d_WorldViewProjState());
62
63   //! @return current camera projection transformation common for all selecting volumes
64   Standard_EXPORT const Graphic3d_Mat4d& ProjectionMatrix() const;
65
66   //! @return current camera world view transformation common for all selecting volumes
67   Standard_EXPORT const Graphic3d_Mat4d& WorldViewMatrix() const;
68
69   //! @return current camera world view projection transformation state
70   Standard_EXPORT const Graphic3d_WorldViewProjState& WorldViewProjState() const;
71
72   Standard_EXPORT void SetPixelTolerance (const Standard_Integer theTol);
73
74   Standard_EXPORT void SetWindowSize (const Standard_Integer theWidth, 
75                                       const Standard_Integer theHeight);
76
77   Standard_EXPORT void WindowSize (Standard_Integer& theWidth,
78                                    Standard_Integer& theHeight) const;
79
80   //! Passes viewport parameters to builder
81   Standard_EXPORT void SetViewport (const Standard_Real theX,
82                                     const Standard_Real theY,
83                                     const Standard_Real theWidth,
84                                     const Standard_Real theHeight);
85
86   //! Nullifies the builder created in the constructor and copies the pointer given
87   Standard_EXPORT void SetBuilder (const Handle(SelectMgr_FrustumBuilder)& theBuilder);
88
89
90   //! Builds volume according to the point and given pixel tolerance
91   virtual void Build (const gp_Pnt2d& /*thePoint*/) {}
92
93   //! Builds volume according to the selected rectangle
94   virtual void Build (const gp_Pnt2d& /*theMinPt*/,
95                       const gp_Pnt2d& /*theMaxPt*/) {}
96
97   //! Builds volume according to the triangle given
98   virtual void Build (const gp_Pnt2d& /*theP1*/,
99                       const gp_Pnt2d& /*theP2*/,
100                       const gp_Pnt2d& /*theP3*/) {}
101
102   //! Builds selecting volumes set according to polyline points
103   virtual void Build (const TColgp_Array1OfPnt2d& /*thePoints*/) {}
104
105   //! IMPORTANT: Scaling makes sense only for frustum built on a single point!
106   //!            Note that this method does not perform any checks on type of the frustum.
107   //! Returns a copy of the frustum resized according to the scale factor given
108   //! and transforms it using the matrix given.
109   //! There are no default parameters, but in case if:
110   //!    - transformation only is needed: @theScaleFactor must be initialized as any negative value;
111   //!    - scale only is needed: @theTrsf must be set to gp_Identity.
112   Standard_EXPORT virtual Handle(SelectMgr_BaseFrustum) ScaleAndTransform (const Standard_Integer /*theScaleFactor*/,
113                                                                            const gp_GTrsf& /*theTrsf*/) const { return NULL; }
114
115   //! SAT intersection test between defined volume and given axis-aligned box
116   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
117                                                      const SelectMgr_Vec3& theBoxMax,
118                                                      Standard_Real& theDepth);
119
120   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
121   //! with minimum corner at point theMinPt and maximum at point theMaxPt
122   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
123                                                      const SelectMgr_Vec3& theBoxMax,
124                                                      Standard_Boolean*     theInside = NULL);
125
126   //! Intersection test between defined volume and given point
127   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
128                                                      Standard_Real& theDepth);
129
130   //! Intersection test between defined volume and given point
131   //! Does not perform depth calculation, so this method is defined as
132   //! helper function for inclusion test. Therefore, its implementation
133   //! makes sense only for rectangular frustum with box selection mode activated.
134   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt);
135
136   //! SAT intersection test between defined volume and given ordered set of points,
137   //! representing line segments. The test may be considered of interior part or
138   //! boundary line defined by segments depending on given sensitivity type
139   Standard_EXPORT virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt& theArrayOfPnts,
140                                                      Select3D_TypeOfSensitivity theSensType,
141                                                      Standard_Real& theDepth);
142
143   //! Checks if line segment overlaps selecting frustum
144   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
145                                                      const gp_Pnt& thePnt2,
146                                                      Standard_Real& theDepth);
147
148   //! SAT intersection test between defined volume and given triangle. The test may
149   //! be considered of interior part or boundary line defined by triangle vertices
150   //! depending on given sensitivity type
151   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePt1,
152                                                      const gp_Pnt& thePt2,
153                                                      const gp_Pnt& thePt3,
154                                                      Select3D_TypeOfSensitivity theSensType,
155                                                      Standard_Real& theDepth);
156
157   //! Measures distance between 3d projection of user-picked
158   //! screen point and given point theCOG
159   Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG);
160
161   Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const;
162
163   //! Checks if the point of sensitive in which selection was detected belongs
164   //! to the region defined by clipping planes
165   Standard_EXPORT virtual Standard_Boolean IsClipped (const Graphic3d_SequenceOfHClipPlane& thePlanes,
166                                                       const Standard_Real theDepth);
167
168   //! Valid for point selection only!
169   //! Computes depth range for global (defined for the whole view) clipping planes.
170   virtual void SetViewClipping (const Handle(Graphic3d_SequenceOfHClipPlane)& /*thePlanes*/) {};
171
172   //! Set if view clipping plane is enabled or not.
173   //! @return previous value of the flag
174   virtual Standard_Boolean SetViewClippingEnabled (const Standard_Boolean /*theToEnable*/) { return Standard_False; }
175
176   //! Stores plane equation coefficients (in the following form:
177   //! Ax + By + Cz + D = 0) to the given vector
178   virtual void GetPlanes (NCollection_Vector<SelectMgr_Vec4>& thePlaneEquations) const
179   {
180     thePlaneEquations.Clear();
181     return;
182   }
183
184   DEFINE_STANDARD_RTTIEXT(SelectMgr_BaseFrustum,Standard_Transient)
185
186 protected:
187   Standard_Integer    myPixelTolerance;      //!< Pixel tolerance
188   Standard_Boolean    myIsOrthographic;      //!< Defines if current camera is orthographic
189
190   Handle(SelectMgr_FrustumBuilder) myBuilder; //!< A tool implementing methods for volume build
191   Handle(Graphic3d_Camera)         myCamera;  //!< camera definition
192 };
193
194 #endif // _SelectMgr_BaseFrustum_HeaderFile