0027562: Coding - avoid exporting of inline methods
[occt.git] / src / SelectMgr / SelectMgr_SelectingVolumeManager.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_SelectingVolumeManager_HeaderFile
17 #define _SelectMgr_SelectingVolumeManager_HeaderFile
18
19 #include <NCollection_Handle.hxx>
20
21 #include <Graphic3d_Camera.hxx>
22 #include <Graphic3d_SequenceOfHClipPlane.hxx>
23 #include <Graphic3d_WorldViewProjState.hxx>
24
25 #include <SelectMgr_BaseFrustum.hxx>
26 #include <SelectMgr_RectangularFrustum.hxx>
27 #include <SelectMgr_TriangularFrustumSet.hxx>
28 #include <SelectBasics_SelectingVolumeManager.hxx>
29
30 //! This class is used to switch between active selecting volumes depending
31 //! on selection type chosen by the user
32 class SelectMgr_SelectingVolumeManager : public SelectBasics_SelectingVolumeManager
33 {
34 public:
35
36   //! Creates instances of all available selecting volume types
37   Standard_EXPORT SelectMgr_SelectingVolumeManager (Standard_Boolean theToAllocateFrustums = Standard_True);
38
39   virtual ~SelectMgr_SelectingVolumeManager() {};
40
41   //! IMPORTANT: Scaling makes sense only for frustum built on a single point!
42   //!            Note that this method does not perform any checks on type of the frustum.
43   //!
44   //! Returns a copy of the frustum resized according to the scale factor given
45   //! and transforms it using the matrix given.
46   //! There are no default parameters, but in case if:
47   //!    - transformation only is needed: @theScaleFactor must be initialized as any negative value;
48   //!    - scale only is needed: @theTrsf must be set to gp_Identity.
49   Standard_EXPORT virtual SelectMgr_SelectingVolumeManager ScaleAndTransform (const Standard_Integer theScaleFactor,
50                                                                               const gp_Trsf& theTrsf);
51
52   Standard_EXPORT virtual Standard_Integer GetActiveSelectionType() const Standard_OVERRIDE;
53
54   Standard_EXPORT void SetActiveSelectionType (const SelectionType& theType);
55
56   //! Updates camera projection and orientation matrices in all selecting volumes
57   Standard_EXPORT void SetCamera (const Handle(Graphic3d_Camera) theCamera);
58
59   //! Updates camera projection and orientation matrices in all selecting volumes
60   Standard_EXPORT void SetCamera (const Graphic3d_Mat4d& theProjection,
61                                   const Graphic3d_Mat4d& theWorldView,
62                                   const Standard_Boolean theIsOrthographic,
63                                   const Graphic3d_WorldViewProjState& theWVPState = Graphic3d_WorldViewProjState());
64
65   //! @return current projection transformation common for all selecting volumes
66   Standard_EXPORT const Graphic3d_Mat4d& ProjectionMatrix() const;
67
68   //! @return current world view transformation common for all selecting volumes
69   Standard_EXPORT const Graphic3d_Mat4d& WorldViewMatrix() const;
70
71   //! @return current camera world view projection transformation state common for all selecting volumes
72   Standard_EXPORT const Graphic3d_WorldViewProjState& WorldViewProjState() const;
73
74   //! Updates viewport in all selecting volumes
75   Standard_EXPORT void SetViewport (const Standard_Real theX,
76                                     const Standard_Real theY,
77                                     const Standard_Real theWidth,
78                                     const Standard_Real theHeight);
79
80   //! Updates pixel tolerance in all selecting volumes
81   Standard_EXPORT void SetPixelTolerance (const Standard_Integer theTolerance);
82
83   //! Updates window size in all selecting volumes
84   Standard_EXPORT void SetWindowSize (const Standard_Integer theWidth, const Standard_Integer theHeight);
85
86
87   //! Builds rectangular selecting frustum for point selection
88   Standard_EXPORT void BuildSelectingVolume (const gp_Pnt2d& thePoint);
89
90   //! Builds rectangular selecting frustum for box selection
91   Standard_EXPORT void BuildSelectingVolume (const gp_Pnt2d& theMinPt,
92                                              const gp_Pnt2d& theMaxPt);
93
94   //! Builds set of triangular selecting frustums for polyline selection
95   Standard_EXPORT void BuildSelectingVolume (const TColgp_Array1OfPnt2d& thePoints);
96
97
98   //! SAT intersection test between defined volume and given axis-aligned box
99   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
100                                                       const SelectMgr_Vec3& theBoxMax,
101                                                      Standard_Real& theDepth) Standard_OVERRIDE;
102
103   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
104   //! with minimum corner at point theMinPt and maximum at point theMaxPt
105   Standard_EXPORT  virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
106                                                       const SelectMgr_Vec3& theBoxMax,
107                                                       Standard_Boolean*     theInside = NULL) Standard_OVERRIDE;
108
109   //! Intersection test between defined volume and given point
110   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
111                                                      Standard_Real& theDepth) Standard_OVERRIDE;
112
113   //! Intersection test between defined volume and given point
114   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt) Standard_OVERRIDE;
115
116   //! SAT intersection test between defined volume and given ordered set of points,
117   //! representing line segments. The test may be considered of interior part or
118   //! boundary line defined by segments depending on given sensitivity type
119   Standard_EXPORT virtual Standard_Boolean Overlaps (const Handle(TColgp_HArray1OfPnt)& theArrayOfPts,
120                                                      Standard_Integer theSensType,
121                                                      Standard_Real& theDepth) Standard_OVERRIDE;
122
123   //! SAT intersection test between defined volume and given ordered set of points,
124   //! representing line segments. The test may be considered of interior part or
125   //! boundary line defined by segments depending on given sensitivity type
126   Standard_EXPORT virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt& theArrayOfPts,
127                                                      Standard_Integer theSensType,
128                                                      Standard_Real& theDepth) Standard_OVERRIDE;
129
130   //! Checks if line segment overlaps selecting frustum
131   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
132                                                      const gp_Pnt& thePnt2,
133                                                      Standard_Real& theDepth) Standard_OVERRIDE;
134
135   //! SAT intersection test between defined volume and given triangle. The test may
136   //! be considered of interior part or boundary line defined by triangle vertices
137   //! depending on given sensitivity type
138   Standard_EXPORT  virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
139                                                       const gp_Pnt& thePnt2,
140                                                       const gp_Pnt& thePnt3,
141                                                       Standard_Integer theSensType,
142                                                       Standard_Real& theDepth) Standard_OVERRIDE;
143
144
145   //! Measures distance between 3d projection of user-picked
146   //! screen point and given point theCOG
147   Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) Standard_OVERRIDE;
148
149   //! Calculates the point on a view ray that was detected during the run of selection algo by given depth. Is valid for point
150   //! selection only
151   Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const Standard_OVERRIDE;
152
153   //! Checks if the point of sensitive in which selection was detected belongs
154   //! to the region defined by clipping planes
155   Standard_EXPORT virtual Standard_Boolean IsClipped (const Graphic3d_SequenceOfHClipPlane& thePlanes,
156                                                       const Standard_Real& theDepth);
157
158   //! Is used for rectangular selection only
159   //! If theIsToAllow is false, only fully included sensitives will be detected, otherwise the algorithm will
160   //! mark both included and overlapped entities as matched
161   Standard_EXPORT virtual void AllowOverlapDetection (const Standard_Boolean theIsToAllow);
162
163   Standard_EXPORT virtual Standard_Boolean IsOverlapAllowed() const Standard_OVERRIDE;
164
165   //! Valid for point selection only!
166   //! Computes depth range for global (defined for the whole view) clipping planes.
167   Standard_EXPORT void SetViewClipping (const Graphic3d_SequenceOfHClipPlane& thePlanes);
168
169   //! A set of helper functions that return rectangular selecting frustum data
170   Standard_EXPORT const gp_Pnt* GetVertices() const;
171
172   Standard_EXPORT gp_Pnt GetNearPnt() const;
173
174   Standard_EXPORT gp_Pnt GetFarPnt() const;
175
176 private:
177   enum { Frustum, FrustumSet, VolumeTypesNb };       //!< Defines the amount of available selecting volumes
178
179   NCollection_Handle<SelectMgr_BaseFrustum> mySelectingVolumes[VolumeTypesNb];      //!< Array of selecting volumes
180   Standard_Boolean                          myToAllowOverlap;      //!< Defines if partially overlapped entities will me detected or not
181 };
182
183 #endif