f751596e |
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> |
3bf9a45f |
20 | #include <gp_Pnt.hxx> |
f751596e |
21 | #include <TColgp_HArray1OfPnt.hxx> |
17017555 |
22 | #include <SelectBasics_PickResult.hxx> |
bc73b006 |
23 | #include <Standard_Dump.hxx> |
f751596e |
24 | |
25 | class Bnd_Box; |
26 | class gp_Pnt; |
f751596e |
27 | |
28 | //! This class provides an interface for selecting volume manager, |
29 | //! which is responsible for all overlap detection methods and |
30 | //! calculation of minimum depth, distance to center of geometry |
31 | //! and detected closest point on entity. |
32 | class SelectBasics_SelectingVolumeManager |
33 | { |
34 | public: |
35 | |
36 | //! Available selection types |
37 | enum SelectionType { Point, Box, Polyline, Unknown }; |
38 | |
39 | public: |
40 | |
d533dafb |
41 | SelectBasics_SelectingVolumeManager() |
42 | : myActiveSelectionType(Unknown) |
43 | { |
44 | } |
f751596e |
45 | |
b31fbc83 |
46 | virtual ~SelectBasics_SelectingVolumeManager() {} |
f751596e |
47 | |
7ab15952 |
48 | virtual Standard_Integer GetActiveSelectionType() const = 0; |
f751596e |
49 | |
50 | //! Returns true if selecting volume is overlapped by box theBox |
3bf9a45f |
51 | virtual Standard_Boolean Overlaps (const NCollection_Vec3<Standard_Real>& theBoxMin, |
52 | const NCollection_Vec3<Standard_Real>& theBoxMax, |
4a056d20 |
53 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
54 | |
55 | //! Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum |
56 | //! corner at point theMinPt and maximum at point theMaxPt |
2157d6ac |
57 | virtual Standard_Boolean Overlaps (const NCollection_Vec3<Standard_Real>& theBoxMin, |
58 | const NCollection_Vec3<Standard_Real>& theBoxMax, |
4a056d20 |
59 | Standard_Boolean* theInside = NULL) const = 0; |
f751596e |
60 | |
3bf9a45f |
61 | //! Returns true if selecting volume is overlapped by point thePnt |
62 | virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt, |
4a056d20 |
63 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
64 | |
3bf9a45f |
65 | //! Returns true if selecting volume is overlapped by point thePnt. |
66 | //! Does not perform depth calculation, so this method is defined as |
67 | //! helper function for inclusion test. |
4a056d20 |
68 | virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt) const = 0; |
3bf9a45f |
69 | |
f751596e |
70 | //! Returns true if selecting volume is overlapped by planar convex polygon, which points |
71 | //! are stored in theArrayOfPts, taking into account sensitivity type theSensType |
7ab15952 |
72 | virtual Standard_Boolean Overlaps (const Handle(TColgp_HArray1OfPnt)& theArrayOfPts, |
73 | Standard_Integer theSensType, |
4a056d20 |
74 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
75 | |
114b7bf1 |
76 | //! Returns true if selecting volume is overlapped by planar convex polygon, which points |
77 | //! are stored in theArrayOfPts, taking into account sensitivity type theSensType |
78 | virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt& theArrayOfPts, |
79 | Standard_Integer theSensType, |
4a056d20 |
80 | SelectBasics_PickResult& thePickResult) const = 0; |
114b7bf1 |
81 | |
f751596e |
82 | //! Returns true if selecting volume is overlapped by line segment with start point at thePt1 |
83 | //! and end point at thePt2 |
7ab15952 |
84 | virtual Standard_Boolean Overlaps (const gp_Pnt& thePt1, |
85 | const gp_Pnt& thePt2, |
4a056d20 |
86 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
87 | |
88 | //! Returns true if selecting volume is overlapped by triangle with vertices thePt1, |
89 | //! thePt2 and thePt3, taking into account sensitivity type theSensType |
7ab15952 |
90 | virtual Standard_Boolean Overlaps (const gp_Pnt& thePt1, |
91 | const gp_Pnt& thePt2, |
92 | const gp_Pnt& thePt3, |
93 | Standard_Integer theSensType, |
4a056d20 |
94 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
95 | |
96 | //! Calculates distance from 3d projection of user-defined selection point |
97 | //! to the given point theCOG |
4a056d20 |
98 | virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) const = 0; |
f751596e |
99 | |
3bf9a45f |
100 | virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const = 0; |
f751596e |
101 | |
2157d6ac |
102 | virtual Standard_Boolean IsOverlapAllowed() const = 0; |
103 | |
21a8e275 |
104 | //! Valid only for point and rectangular selection. |
105 | //! Returns projection of 2d mouse picked point or projection |
106 | //! of center of 2d rectangle (for point and rectangular selection |
107 | //! correspondingly) onto near view frustum plane |
108 | virtual gp_Pnt GetNearPickedPnt() const = 0; |
109 | |
110 | //! Valid only for point and rectangular selection. |
111 | //! Returns projection of 2d mouse picked point or projection |
112 | //! of center of 2d rectangle (for point and rectangular selection |
113 | //! correspondingly) onto far view frustum plane |
114 | virtual gp_Pnt GetFarPickedPnt() const = 0; |
115 | |
b30b2c13 |
116 | //! Return mouse coordinates for Point selection mode. |
117 | virtual gp_Pnt2d GetMousePosition() const = 0; |
118 | |
871dcdc2 |
119 | //! Stores plane equation coefficients (in the following form: |
120 | //! Ax + By + Cz + D = 0) to the given vector |
121 | virtual void GetPlanes (NCollection_Vector<NCollection_Vec4<Standard_Real> >& thePlaneEquations) const = 0; |
122 | |
bc73b006 |
123 | //! Dumps the content of me into the stream |
124 | virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const |
125 | { (void)theDepth; OCCT_DUMP_FIELD_VALUE_NUMERICAL (theOStream, myActiveSelectionType) } |
126 | |
f751596e |
127 | protected: |
128 | SelectionType myActiveSelectionType; //!< Active selection type: point, box or polyline |
129 | }; |
130 | |
131 | #endif // _SelectBasics_SelectingVolumeManager_HeaderFile |