src/SelectBasics/SelectBasics_PickResult.hxx

   1 // Created on: 2014-11-14
   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_PickResult_HeaderFile
  17 #define _SelectBasics_PickResult_HeaderFile
  18
  19 #include <Standard.hxx>
  20 #include <NCollection_Vec4.hxx>
  21
  22 //! This structure provides unified access to the results of
  23 //! Matches() method in all sensitive entities.
  24 struct SelectBasics_PickResult
  25 {
  26 public:
  27
  28   SelectBasics_PickResult()
  29   : myDepth (DBL_MAX),
  30     myDistToCenter (DBL_MAX) {}
  31
  32   SelectBasics_PickResult (const Standard_Real theDepth,
  33                            const Standard_Real theDistToCenter)
  34   : myDepth (theDepth),
  35     myDistToCenter (theDistToCenter) {}
  36
  37 public:
  38   inline Standard_Real Depth() const
  39   {
  40     return myDepth;
  41   }
  42
  43   inline Standard_Real DistToGeomCenter() const
  44   {
  45     return myDistToCenter;
  46   }
  47
  48 private:
  49   //!< Depth to detected point
  50   Standard_Real                   myDepth;
  51   //!< Distance from 3d projection user-picked selection point to entity's geometry center
  52   Standard_Real                   myDistToCenter;
  53 };
  54
  55 #endif // _SelectBasics_PickResult_HeaderFile