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 | |
e1eb39d2 |
36 | SelectBasics_SelectingVolumeManager() {} |
f751596e |
37 | |
b31fbc83 |
38 | virtual ~SelectBasics_SelectingVolumeManager() {} |
f751596e |
39 | |
7ab15952 |
40 | virtual Standard_Integer GetActiveSelectionType() const = 0; |
f751596e |
41 | |
42 | //! Returns true if selecting volume is overlapped by box theBox |
03c9cc86 |
43 | virtual Standard_Boolean OverlapsBox (const NCollection_Vec3<Standard_Real>& theBoxMin, |
44 | const NCollection_Vec3<Standard_Real>& theBoxMax, |
45 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
46 | |
47 | //! Returns true if selecting volume is overlapped by axis-aligned bounding box with minimum |
48 | //! corner at point theMinPt and maximum at point theMaxPt |
03c9cc86 |
49 | virtual Standard_Boolean OverlapsBox (const NCollection_Vec3<Standard_Real>& theBoxMin, |
50 | const NCollection_Vec3<Standard_Real>& theBoxMax, |
51 | Standard_Boolean* theInside = NULL) const = 0; |
f751596e |
52 | |
3bf9a45f |
53 | //! Returns true if selecting volume is overlapped by point thePnt |
03c9cc86 |
54 | virtual Standard_Boolean OverlapsPoint (const gp_Pnt& thePnt, |
55 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
56 | |
3bf9a45f |
57 | //! Returns true if selecting volume is overlapped by point thePnt. |
58 | //! Does not perform depth calculation, so this method is defined as |
59 | //! helper function for inclusion test. |
03c9cc86 |
60 | virtual Standard_Boolean OverlapsPoint (const gp_Pnt& thePnt) const = 0; |
3bf9a45f |
61 | |
f751596e |
62 | //! Returns true if selecting volume is overlapped by planar convex polygon, which points |
63 | //! are stored in theArrayOfPts, taking into account sensitivity type theSensType |
03c9cc86 |
64 | virtual Standard_Boolean OverlapsPolygon (const Handle(TColgp_HArray1OfPnt)& theArrayOfPts, |
65 | Standard_Integer theSensType, |
66 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
67 | |
114b7bf1 |
68 | //! Returns true if selecting volume is overlapped by planar convex polygon, which points |
69 | //! are stored in theArrayOfPts, taking into account sensitivity type theSensType |
03c9cc86 |
70 | virtual Standard_Boolean OverlapsPolygon (const TColgp_Array1OfPnt& theArrayOfPts, |
71 | Standard_Integer theSensType, |
72 | SelectBasics_PickResult& thePickResult) const = 0; |
114b7bf1 |
73 | |
f751596e |
74 | //! Returns true if selecting volume is overlapped by line segment with start point at thePt1 |
75 | //! and end point at thePt2 |
03c9cc86 |
76 | virtual Standard_Boolean OverlapsSegment (const gp_Pnt& thePt1, |
77 | const gp_Pnt& thePt2, |
78 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
79 | |
80 | //! Returns true if selecting volume is overlapped by triangle with vertices thePt1, |
81 | //! thePt2 and thePt3, taking into account sensitivity type theSensType |
03c9cc86 |
82 | virtual Standard_Boolean OverlapsTriangle (const gp_Pnt& thePt1, |
83 | const gp_Pnt& thePt2, |
84 | const gp_Pnt& thePt3, |
85 | Standard_Integer theSensType, |
86 | SelectBasics_PickResult& thePickResult) const = 0; |
f751596e |
87 | |
88 | //! Calculates distance from 3d projection of user-defined selection point |
89 | //! to the given point theCOG |
4a056d20 |
90 | virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) const = 0; |
f751596e |
91 | |
3bf9a45f |
92 | virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const = 0; |
f751596e |
93 | |
2157d6ac |
94 | virtual Standard_Boolean IsOverlapAllowed() const = 0; |
95 | |
21a8e275 |
96 | //! Valid only for point and rectangular selection. |
97 | //! Returns projection of 2d mouse picked point or projection |
98 | //! of center of 2d rectangle (for point and rectangular selection |
99 | //! correspondingly) onto near view frustum plane |
100 | virtual gp_Pnt GetNearPickedPnt() const = 0; |
101 | |
102 | //! Valid only for point and rectangular selection. |
103 | //! Returns projection of 2d mouse picked point or projection |
104 | //! of center of 2d rectangle (for point and rectangular selection |
105 | //! correspondingly) onto far view frustum plane |
106 | virtual gp_Pnt GetFarPickedPnt() const = 0; |
107 | |
e1eb39d2 |
108 | //! Valid only for point and rectangular selection. |
109 | //! Returns view ray direction |
110 | virtual gp_Dir GetViewRayDirection() const = 0; |
111 | |
112 | //! Checks if it is possible to scale current active selecting volume |
113 | virtual Standard_Boolean IsScalableActiveVolume() const = 0; |
114 | |
115 | //! Returns mouse coordinates for Point selection mode. |
116 | //! @return infinite point in case of unsupport of mouse position for this active selection volume. |
b30b2c13 |
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 |
e1eb39d2 |
125 | { |
126 | (void )theOStream; |
127 | (void )theDepth; |
128 | } |
f751596e |
129 | }; |
130 | |
131 | #endif // _SelectBasics_SelectingVolumeManager_HeaderFile |