0024623: Visualization - improve selection mechanism
[occt.git] / src / SelectBasics / SelectBasics_SelectingVolumeManager.hxx
1 // Created on: 2014-08-21
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 _SelectBasics_SelectingVolumeManager_HeaderFile
17 #define _SelectBasics_SelectingVolumeManager_HeaderFile
18
19 #include <BVH_Box.hxx>
20 #include <TColgp_HArray1OfPnt.hxx>
21 #include <NCollection_Vec3.hxx>
22
23 class Bnd_Box;
24 class gp_Pnt;
25 class TColgp_Array1OfPnt;
26
27 //! This class provides an interface for selecting volume manager,
28 //! which is responsible for all overlap detection methods and
29 //! calculation of minimum depth, distance to center of geometry
30 //! and detected closest point on entity.
31 class SelectBasics_SelectingVolumeManager
32 {
33 public:
34
35   //! Available selection types
36   enum SelectionType { Point, Box, Polyline, Unknown };
37
38 public:
39
40   SelectBasics_SelectingVolumeManager() {};
41
42   virtual ~SelectBasics_SelectingVolumeManager() {};
43
44   virtual const Standard_Integer GetActiveSelectionType() const = 0;
45
46   //! Returns true if selecting volume is overlapped by box theBox
47   virtual const Standard_Boolean Overlaps (const BVH_Box<Standard_Real, 3>& theBox,
48                                            Standard_Real& theDepth) = 0;
49
50   //! Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum
51   //! corner at point theMinPt and maximum at point theMaxPt
52   virtual const Standard_Boolean Overlaps (const NCollection_Vec3<Standard_Real>& theMinPt,
53                                            const NCollection_Vec3<Standard_Real>& theMaxPt) = 0;
54
55   //! Returns true if selecting volume is overlapped by point thePt
56   virtual const Standard_Boolean Overlaps (const gp_Pnt& thePt,
57                                            Standard_Real& theDepth) = 0;
58
59   //! Returns true if selecting volume is overlapped by planar convex polygon, which points
60   //! are stored in theArrayOfPts, taking into account sensitivity type theSensType
61   virtual const Standard_Boolean Overlaps (const Handle(TColgp_HArray1OfPnt)& theArrayOfPts,
62                                            Standard_Integer theSensType,
63                                            Standard_Real& theDepth) = 0;
64
65   //! Returns true if selecting volume is overlapped by line segment with start point at thePt1
66   //! and end point at thePt2
67   virtual const Standard_Boolean Overlaps (const gp_Pnt& thePt1,
68                                            const gp_Pnt& thePt2,
69                                            Standard_Real& theDepth) = 0;
70
71   //! Returns true if selecting volume is overlapped by triangle with vertices thePt1,
72   //! thePt2 and thePt3, taking into account sensitivity type theSensType
73   virtual const Standard_Boolean Overlaps (const gp_Pnt& thePt1,
74                                            const gp_Pnt& thePt2,
75                                            const gp_Pnt& thePt3,
76                                            Standard_Integer theSensType,
77                                            Standard_Real& theDepth) = 0;
78
79   //! Calculates distance from 3d projection of user-defined selection point
80   //! to the given point theCOG
81   virtual const Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) = 0;
82
83   virtual NCollection_Vec3<Standard_Real> DetectedPoint (const Standard_Real theDepth) const = 0;
84
85 protected:
86   SelectionType myActiveSelectionType;      //!< Active selection type: point, box or polyline
87 };
88
89 #endif // _SelectBasics_SelectingVolumeManager_HeaderFile