src/SelectMgr/SelectMgr_RectangularFrustum.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_RectangularFrustum_HeaderFile
  17 #define _SelectMgr_RectangularFrustum_HeaderFile
  18
  19 #include <SelectMgr_Frustum.hxx>
  20
  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
  31 //! theorem (SAT).
  32 class SelectMgr_RectangularFrustum : public SelectMgr_Frustum<4>
  33 {
  34 public:
  35
  36   SelectMgr_RectangularFrustum() {};
  37
  38   //! Builds volume according to the point and given pixel tolerance
  39   virtual void Build (const gp_Pnt2d& thePoint) Standard_OVERRIDE;
  40
  41   //! Builds volume according to the selected rectangle
  42   virtual void Build (const gp_Pnt2d& theMinPnt,
  43                       const gp_Pnt2d& theMaxPnt) Standard_OVERRIDE;
  44
  45   //! Returns a copy of the frustum transformed according to the matrix given
  46   virtual NCollection_Handle<SelectMgr_BaseFrustum> Transform (const gp_Trsf& theTrsf) Standard_OVERRIDE;
  47
  48   //! IMPORTANT: Makes sense only for frustum built on a single point!
  49   //! Returns a copy of the frustum resized according to the scale factor given
  50   virtual NCollection_Handle<SelectMgr_BaseFrustum> Scale (const Standard_Real theScaleFactor) Standard_OVERRIDE;
  51
  52
  53   // SAT Tests for different objects
  54
  55   //! SAT intersection test between defined volume and given axis-aligned box
  56   virtual Standard_Boolean Overlaps (const BVH_Box<Standard_Real, 3>& theBox,
  57                                      Standard_Real& theDepth) Standard_OVERRIDE;
  58
  59   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
  60   //! with minimum corner at point theMinPt and maximum at point theMaxPt
  61   virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
  62                                      const SelectMgr_Vec3& theBoxMax,
  63                                      Standard_Boolean*     theInside = NULL) Standard_OVERRIDE;
  64
  65   //! Intersection test between defined volume and given point
  66   virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
  67                                      Standard_Real& theDepth) Standard_OVERRIDE;
  68
  69   //! SAT intersection test between defined volume and given ordered set of points,
  70   //! representing line segments. The test may be considered of interior part or
  71   //! boundary line defined by segments depending on given sensitivity type
  72   virtual Standard_Boolean Overlaps (const Handle(TColgp_HArray1OfPnt)& theArrayOfPnts,
  73                                      Select3D_TypeOfSensitivity theSensType,
  74                                      Standard_Real& theDepth) Standard_OVERRIDE;
  75
  76   //! Checks if line segment overlaps selecting frustum
  77   virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
  78                                      const gp_Pnt& thePnt2,
  79                                      Standard_Real& theDepth) Standard_OVERRIDE;
  80
  81   //! SAT intersection test between defined volume and given triangle. The test may
  82   //! be considered of interior part or boundary line defined by triangle vertices
  83   //! depending on given sensitivity type
  84   virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
  85                                      const gp_Pnt& thePnt2,
  86                                      const gp_Pnt& thePnt3,
  87                                      Select3D_TypeOfSensitivity theSensType,
  88                                      Standard_Real& theDepth) Standard_OVERRIDE;
  89
  90   //! Measures distance between 3d projection of user-picked
  91   //! screen point and given point theCOG
  92   virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG) Standard_OVERRIDE;
  93
  94   //! Calculates the point on a view ray that was detected during the run of selection algo by given depth
  95   virtual SelectMgr_Vec3 DetectedPoint (const Standard_Real theDepth) const Standard_OVERRIDE;
  96
  97   //! Checks if the point of sensitive in which selection was detected belongs
  98   //! to the region defined by clipping planes
  99   virtual Standard_Boolean IsClipped (const Graphic3d_SequenceOfHClipPlane& thePlanes,
 100                                       const Standard_Real theDepth) Standard_OVERRIDE;
 101
 102 protected:
 103
 104   void segmentSegmentDistance (const gp_Pnt& theSegPnt1,
 105                                const gp_Pnt& theSegPnt2,
 106                                Standard_Real& theDepth);
 107
 108   void segmentPlaneIntersection (const SelectMgr_Vec3& thePlane,
 109                                  const gp_Pnt& thePntOnPlane,
 110                                  Standard_Real& theDepth);
 111
 112 private:
 113
 114   SelectMgr_Vec3 myNearPickedPnt;             //!< 3d projection of user-picked selection point onto near view plane
 115   SelectMgr_Vec3 myFarPickedPnt;              //!< 3d projection of user-picked selection point onto far view plane
 116   SelectMgr_Vec3 myViewRayDir;
 117   gp_Pnt2d       myMousePos;                  //!< Mouse coordinates
 118 };
 119
 120 #endif // _SelectMgr_RectangularFrustum_HeaderFile