src/SelectMgr/SelectMgr_SortCriterion.hxx

   1 // Created on: 1998-03-26
   2 // Created by: Robert COUBLANC
   3 // Copyright (c) 1998-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _SelectMgr_SortCriterion_HeaderFile
  18 #define _SelectMgr_SortCriterion_HeaderFile
  19
  20 #include <Graphic3d_Vec3.hxx>
  21 #include <Graphic3d_ZLayerId.hxx>
  22 #include <Precision.hxx>
  23 #include <Select3D_SensitiveEntity.hxx>
  24
  25 //! This class provides data and criterion for sorting candidate
  26 //! entities in the process of interactive selection by mouse click
  27 class SelectMgr_SortCriterion
  28 {
  29 public:
  30
  31   Handle(Select3D_SensitiveEntity) Entity; //!< detected entity
  32   gp_Pnt             Point;           //!< 3D point
  33   Graphic3d_Vec3     Normal;          //!< surface normal or 0 vector if undefined
  34   Standard_Real      Depth;           //!< distance from the view plane to the entity
  35   Standard_Real      MinDist;         //!< distance from the clicked point to the entity on the view plane
  36   Standard_Real      Tolerance;       //!< tolerance used for selecting candidates
  37   Standard_Integer   Priority;        //!< selection priority
  38   Standard_Integer   ZLayerPosition;  //!< ZLayer rendering order index, stronger than a depth
  39   Standard_Integer   NbOwnerMatches;  //!< overall number of entities collected for the same owner
  40
  41 public:
  42   DEFINE_STANDARD_ALLOC
  43
  44   //! Empty constructor.
  45   SelectMgr_SortCriterion()
  46   : Depth    (0.0),
  47     MinDist  (0.0),
  48     Tolerance(0.0),
  49     Priority (0),
  50     ZLayerPosition (0),
  51     NbOwnerMatches (0) {}
  52
  53   //! Compare with another item by depth, priority and minDist.
  54   bool IsCloserDepth (const SelectMgr_SortCriterion& theOther) const
  55   {
  56     // the object within different ZLayer groups can not be compared by depth
  57     if (ZLayerPosition != theOther.ZLayerPosition)
  58     {
  59       return ZLayerPosition > theOther.ZLayerPosition;
  60     }
  61
  62     // closest object is selected unless difference is within tolerance
  63     if (Abs (Depth - theOther.Depth) > (Tolerance + theOther.Tolerance))
  64     {
  65       return Depth < theOther.Depth;
  66     }
  67
  68     // if two objects have similar depth, select the one with higher priority
  69     if (Priority > theOther.Priority)
  70     {
  71       return true;
  72     }
  73
  74     // if priorities are equal, one closest to the mouse
  75     return Priority == theOther.Priority
  76         && MinDist  <  theOther.MinDist;
  77   }
  78
  79   //! Compare with another item using old logic (OCCT version <= 6.3.1) with priority considered preceding depth.
  80   bool IsHigherPriority (const SelectMgr_SortCriterion& theOther) const
  81   {
  82     // the object within different ZLayer groups can not be compared by depth
  83     if (ZLayerPosition != theOther.ZLayerPosition)
  84     {
  85       return ZLayerPosition > theOther.ZLayerPosition;
  86     }
  87
  88     if (Priority > theOther.Priority)
  89     {
  90       return true;
  91     }
  92     else if (Priority != theOther.Priority)
  93     {
  94       return false;
  95     }
  96
  97     //if (Abs (Depth - theOther.Depth) <= (Tolerance + theOther.Tolerance))
  98     if (Abs (Depth - theOther.Depth) <= Precision::Confusion())
  99     {
 100       return MinDist < theOther.MinDist;
 101     }
 102
 103     return Depth < theOther.Depth;
 104   }
 105
 106 };
 107
 108 #endif // _SelectMgr_SortCriterion_HeaderFile