src/SelectMgr/SelectMgr_BaseFrustum.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_BaseFrustum_HeaderFile
  17 #define _SelectMgr_BaseFrustum_HeaderFile
  18
  19 #include <gp_Pnt.hxx>
  20 #include <gp_Pln.hxx>
  21
  22 #include <Graphic3d_Camera.hxx>
  23 #include <Graphic3d_ClipPlane.hxx>
  24 #include <Graphic3d_SequenceOfHClipPlane.hxx>
  25 #include <Graphic3d_WorldViewProjState.hxx>
  26
  27 #include <TColgp_HArray1OfPnt.hxx>
  28 #include <TColgp_Array1OfPnt2d.hxx>
  29
  30 #include <Select3D_BndBox3d.hxx>
  31 #include <SelectMgr_FrustumBuilder.hxx>
  32 #include <Select3D_TypeOfSensitivity.hxx>
  33 #include <SelectMgr_VectorTypes.hxx>
  34
  35 //! This class is an interface for different types of selecting frustums,
  36 //! defining different selection types, like point, box or polyline
  37 //! selection. It contains signatures of functions for detection of
  38 //! overlap by sensitive entity and initializes some data for building
  39 //! the selecting frustum
  40 class SelectMgr_BaseFrustum : public Standard_Transient
  41 {
  42 public:
  43
  44   //! Creates new selecting volume with pixel toletance set to 2,
  45   //! orthographic camera and empty frustum builder
  46   Standard_EXPORT SelectMgr_BaseFrustum();
  47
  48   virtual ~SelectMgr_BaseFrustum() {}
  49
  50   //! Passes camera projection and orientation matrices to builder
  51   Standard_EXPORT void SetCamera (const Handle(Graphic3d_Camera)& theCamera);
  52
  53   //! Passes camera projection and orientation matrices to builder
  54   Standard_EXPORT void SetCamera (const Graphic3d_Mat4d& theProjection,
  55                                   const Graphic3d_Mat4d& theWorldView,
  56                                   const Standard_Integer theIsOrthographic,
  57                                   const Graphic3d_WorldViewProjState& theWVPState = Graphic3d_WorldViewProjState());
  58
  59   //! @return current camera projection transformation common for all selecting volumes
  60   Standard_EXPORT const Graphic3d_Mat4d& ProjectionMatrix() const;
  61
  62   //! @return current camera world view transformation common for all selecting volumes
  63   Standard_EXPORT const Graphic3d_Mat4d& WorldViewMatrix() const;
  64
  65   //! @return current camera world view projection transformation state
  66   Standard_EXPORT const Graphic3d_WorldViewProjState& WorldViewProjState() const;
  67
  68   Standard_EXPORT void SetPixelTolerance (const Standard_Integer theTol);
  69
  70   Standard_EXPORT void SetWindowSize (const Standard_Integer theWidth,
  71                                       const Standard_Integer theHeight);
  72
  73   //! Passes viewport parameters to builder
  74   Standard_EXPORT void SetViewport (const Standard_Real theX,
  75                                     const Standard_Real theY,
  76                                     const Standard_Real theWidth,
  77                                     const Standard_Real theHeight);
  78
  79   //! Nullifies the builder created in the constructor and copies the pointer given
  80   Standard_EXPORT void SetBuilder (const Handle(SelectMgr_FrustumBuilder)& theBuilder);
  81
  82
  83   //! Builds volume according to the point and given pixel tolerance
  84   virtual void Build (const gp_Pnt2d& /*thePoint*/) {}
  85
  86   //! Builds volume according to the selected rectangle
  87   virtual void Build (const gp_Pnt2d& /*theMinPt*/,
  88                       const gp_Pnt2d& /*theMaxPt*/) {}
  89
  90   //! Builds volume according to the triangle given
  91   virtual void Build (const gp_Pnt2d& /*theP1*/,
  92                       const gp_Pnt2d& /*theP2*/,
  93                       const gp_Pnt2d& /*theP3*/) {}
  94
  95   //! Builds selecting volumes set according to polyline points
  96   virtual void Build (const TColgp_Array1OfPnt2d& /*thePoints*/) {}
  97
  98   //! IMPORTANT: Scaling makes sense only for frustum built on a single point!
  99   //!            Note that this method does not perform any checks on type of the frustum.
 100   //! Returns a copy of the frustum resized according to the scale factor given
 101   //! and transforms it using the matrix given.
 102   //! There are no default parameters, but in case if:
 103   //!    - transformation only is needed: @theScaleFactor must be initialized as any negative value;
 104   //!    - scale only is needed: @theTrsf must be set to gp_Identity.
 105   Standard_EXPORT virtual NCollection_Handle<SelectMgr_BaseFrustum> ScaleAndTransform (const Standard_Integer /*theScaleFactor*/,
 106                                                                                        const gp_Trsf& /*theTrsf*/) { return NULL; }
 107
 108   //! SAT intersection test between defined volume and given axis-aligned box
 109   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
 110                                                      const SelectMgr_Vec3& theBoxMax,
 111                                                      Standard_Real& theDepth);
 112
 113   //! Returns true if selecting volume is overlapped by axis-aligned bounding box
 114   //! with minimum corner at point theMinPt and maximum at point theMaxPt
 115   Standard_EXPORT virtual Standard_Boolean Overlaps (const SelectMgr_Vec3& theBoxMin,
 116                                                      const SelectMgr_Vec3& theBoxMax,
 117                                                      Standard_Boolean*     theInside = NULL);
 118
 119   //! Intersection test between defined volume and given point
 120   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt,
 121                                                      Standard_Real& theDepth);
 122
 123   //! Intersection test between defined volume and given point
 124   //! Does not perform depth calculation, so this method is defined as
 125   //! helper function for inclusion test. Therefore, its implementation
 126   //! makes sense only for rectangular frustum with box selection mode activated.
 127   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt);
 128
 129   //! SAT intersection test between defined volume and given ordered set of points,
 130   //! representing line segments. The test may be considered of interior part or
 131   //! boundary line defined by segments depending on given sensitivity type
 132   Standard_EXPORT virtual Standard_Boolean Overlaps (const Handle(TColgp_HArray1OfPnt)& theArrayOfPnts,
 133                                                      Select3D_TypeOfSensitivity theSensType,
 134                                                      Standard_Real& theDepth);
 135
 136   //! Checks if line segment overlaps selecting frustum
 137   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePnt1,
 138                                                      const gp_Pnt& thePnt2,
 139                                                      Standard_Real& theDepth);
 140
 141   //! SAT intersection test between defined volume and given triangle. The test may
 142   //! be considered of interior part or boundary line defined by triangle vertices
 143   //! depending on given sensitivity type
 144   Standard_EXPORT virtual Standard_Boolean Overlaps (const gp_Pnt& thePt1,
 145                                                      const gp_Pnt& thePt2,
 146                                                      const gp_Pnt& thePt3,
 147                                                      Select3D_TypeOfSensitivity theSensType,
 148                                                      Standard_Real& theDepth);
 149
 150   //! Measures distance between 3d projection of user-picked
 151   //! screen point and given point theCOG
 152   Standard_EXPORT virtual Standard_Real DistToGeometryCenter (const gp_Pnt& theCOG);
 153
 154   Standard_EXPORT virtual gp_Pnt DetectedPoint (const Standard_Real theDepth) const;
 155
 156   //! Checks if the point of sensitive in which selection was detected belongs
 157   //! to the region defined by clipping planes
 158   Standard_EXPORT virtual Standard_Boolean IsClipped (const Graphic3d_SequenceOfHClipPlane& thePlanes,
 159                                                       const Standard_Real theDepth);
 160
 161   //! Valid for point selection only!
 162   //! Computes depth range for global (defined for the whole view) clipping planes.
 163   Standard_EXPORT virtual void SetViewClipping (const Graphic3d_SequenceOfHClipPlane& /*thePlanes*/) {};
 164
 165   DEFINE_STANDARD_RTTIEXT(SelectMgr_BaseFrustum,Standard_Transient)
 166
 167 protected:
 168   Standard_Integer    myPixelTolerance;      //!< Pixel tolerance
 169   Standard_Boolean    myIsOrthographic;      //!< Defines if current camera is orthographic
 170
 171   Handle(SelectMgr_FrustumBuilder) myBuilder; //!< A tool implementing methods for volume build
 172 };
 173
 174 #endif // _SelectMgr_BaseFrustum_HeaderFile