1 // Created on: 2014-05-22
2 // Created by: Varvara POSKONINA
3 // Copyright (c) 2005-2014 OPEN CASCADE SAS
5 // This file is part of Open CASCADE Technology software library.
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.
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
16 #ifndef _SelectMgr_RectangularFrustum_HeaderFile
17 #define _SelectMgr_RectangularFrustum_HeaderFile
19 #include <SelectMgr_Frustum.hxx>
21 //! This class contains representation of rectangular selecting frustum, created in case
22 //! of point and box selection, and algorithms for overlap detection between selecting
23 //! frustum and sensitive entities. The principle of frustum calculation:
24 //! - for point selection: on a near view frustum plane rectangular neighborhood of
25 //! user-picked point is created according to the pixel tolerance
26 //! given and then this rectangle is projected onto far view frustum
27 //! plane. This rectangles define the parallel bases of selecting frustum;
28 //! - for box selection: box points are projected onto near and far view frustum planes.
29 //! These 2 projected rectangles define parallel bases of selecting frustum.
30 //! Overlap detection tests are implemented according to the terms of separating axis
32 class SelectMgr_RectangularFrustum : public SelectMgr_Frustum<4>
36 SelectMgr_RectangularFrustum() : myScale (1.0) {};
38 //! Builds volume according to the point and given pixel tolerance
39 Standard_EXPORT virtual void Build (const gp_Pnt2d& thePoint) Standard_OVERRIDE;
41 //! Builds volume according to the selected rectangle
42 Standard_EXPORT virtual void Build (const gp_Pnt2d& theMinPnt,
43 const gp_Pnt2d& theMaxPnt) Standard_OVERRIDE;
45 //! IMPORTANT: Scaling makes sense only for frustum built on a single point!
46 //! Note that this method does not perform any checks on type of the frustum.
47 //! Returns a copy of the frustum resized according to the scale factor given
48 //! and transforms it using the matrix given.
49 //! There are no default parameters, but in case if:
50 //! - transformation only is needed: @theScaleFactor must be initialized as any negative value;
51 //! - scale only is needed: @theTrsf must be set to gp_Identity.
52 Standard_EXPORT virtual Handle(SelectMgr_BaseFrustum) ScaleAndTransform (const Standard_Integer theScaleFactor,
53 const gp_GTrsf& theTrsf) const Standard_OVERRIDE;
56 // SAT Tests for different objects
58 //! SAT intersection test between defined volume and given axis-aligned box
59 Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
60 const SelectMgr_Vec3& theBoxMax,
61 const SelectMgr_ViewClipRange& theClipRange,
62 SelectBasics_PickResult& thePickResult) const Standard_OVERRIDE;
64 //! Returns true if selecting volume is overlapped by axis-aligned bounding box
65 //! with minimum corner at point theMinPt and maximum at point theMaxPt
66 Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
67 const SelectMgr_Vec3& theBoxMax,
68 Standard_Boolean* theInside) const Standard_OVERRIDE;
70 //! Intersection test between defined volume and given point
71 Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
72 const SelectMgr_ViewClipRange& theClipRange,
73 SelectBasics_PickResult& thePickResult) const Standard_OVERRIDE;
75 //! Intersection test between defined volume and given point
76 Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt) const Standard_OVERRIDE;
78 //! SAT intersection test between defined volume and given ordered set of points,
79 //! representing line segments. The test may be considered of interior part or
80 //! boundary line defined by segments depending on given sensitivity type
81 Standard_EXPORT virtual Standard_Boolean Overlaps (const TColgp_Array1OfPnt& theArrayOfPnts,
82 Select3D_TypeOfSensitivity theSensType,
83 const SelectMgr_ViewClipRange& theClipRange,
84 SelectBasics_PickResult& thePickResult) const Standard_OVERRIDE;
86 //! Checks if line segment overlaps selecting frustum
87 Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
88 const gp_Pnt& thePnt2,
89 const SelectMgr_ViewClipRange& theClipRange,
90 SelectBasics_PickResult& thePickResult) const Standard_OVERRIDE;
92 //! SAT intersection test between defined volume and given triangle. The test may
93 //! be considered of interior part or boundary line defined by triangle vertices
94 //! depending on given sensitivity type
95 Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
96 const gp_Pnt& thePnt2,
97 const gp_Pnt& thePnt3,
98 Select3D_TypeOfSensitivity theSensType,
99 const SelectMgr_ViewClipRange& theClipRange,
100 SelectBasics_PickResult& thePickResult) const Standard_OVERRIDE;
102 //! Measures distance between 3d projection of user-picked
103 //! screen point and given point theCOG
104 Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) const Standard_OVERRIDE;
106 //! Calculates the point on a view ray that was detected during the run of selection algo by given depth
107 Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const Standard_OVERRIDE;
109 //! A set of helper functions that return rectangular selecting frustum data
110 inline const gp_Pnt* GetVertices() const { return myVertices; }
112 //! Returns projection of 2d mouse picked point or projection
113 //! of center of 2d rectangle (for point and rectangular selection
114 //! correspondingly) onto near view frustum plane
115 inline const gp_Pnt& GetNearPnt() const { return myNearPickedPnt; }
117 //! Returns projection of 2d mouse picked point or projection
118 //! of center of 2d rectangle (for point and rectangular selection
119 //! correspondingly) onto far view frustum plane
120 inline const gp_Pnt& GetFarPnt() const { return myFarPickedPnt; }
122 //! Return view ray direction.
123 const gp_Dir& GetViewRayDirection() const { return myViewRayDir; }
125 //! Return mouse coordinates.
126 const gp_Pnt2d& GetMousePosition() const { return myMousePos; }
128 //! Stores plane equation coefficients (in the following form:
129 //! Ax + By + Cz + D = 0) to the given vector
130 Standard_EXPORT virtual void GetPlanes (NCollection_Vector<SelectMgr_Vec4>& thePlaneEquations) const Standard_OVERRIDE;
132 //! Dumps the content of me into the stream
133 Standard_EXPORT virtual void DumpJson (Standard_OStream& theOStream, Standard_Integer theDepth = -1) const Standard_OVERRIDE;
137 Standard_EXPORT void segmentSegmentDistance (const gp_Pnt& theSegPnt1,
138 const gp_Pnt& theSegPnt2,
139 SelectBasics_PickResult& thePickResult) const;
141 Standard_EXPORT bool segmentPlaneIntersection (const gp_Vec& thePlane,
142 const gp_Pnt& thePntOnPlane,
143 SelectBasics_PickResult& thePickResult) const;
147 void cacheVertexProjections (SelectMgr_RectangularFrustum* theFrustum) const;
150 enum { LeftTopNear, LeftTopFar,
151 LeftBottomNear, LeftBottomFar,
152 RightTopNear, RightTopFar,
153 RightBottomNear, RightBottomFar };
157 gp_Pnt myNearPickedPnt; //!< 3d projection of user-picked selection point onto near view plane
158 gp_Pnt myFarPickedPnt; //!< 3d projection of user-picked selection point onto far view plane
160 gp_Pnt2d myMousePos; //!< Mouse coordinates
161 Standard_Real myScale; //!< Scale factor of applied transformation, if there was any
165 #endif // _SelectMgr_RectangularFrustum_HeaderFile