src/PartSet/PartSet_Filters.h

   1 // Copyright (C) 2014-2021  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef PartSet_Filters_H
  21 #define PartSet_Filters_H
  22
  23 #include <ModuleBase_ViewerFilters.h>
  24
  25 #include <set>
  26 #include <string>
  27
  28 /**
  29 * \class PartSet_GlobalFilter
  30 * \ingroup Modules
  31 * A class which filters groups object in addition to documents (see issue #310)
  32 */
  33 DEFINE_STANDARD_HANDLE(PartSet_GlobalFilter, ModuleBase_ShapeDocumentFilter);
  34 class PartSet_GlobalFilter: public ModuleBase_ShapeDocumentFilter
  35 {
  36 public:
  37   /// Constructor
  38   /// \param theWorkshop a pointer to workshop
  39   PartSet_GlobalFilter(ModuleBase_IWorkshop* theWorkshop);
  40
  41   /// Returns True if selected presentation can be selected
  42   /// \param theOwner an owner of the persentation
  43   Standard_EXPORT virtual Standard_Boolean
  44     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  45
  46   DEFINE_STANDARD_RTTIEXT(PartSet_GlobalFilter, ModuleBase_ShapeDocumentFilter)
  47 };
  48
  49 /// \class PartSet_ResultGroupNameFilter
  50 /// \ingroup Modules
  51 /// A class which filters results with groupName() result in filter parameters
  52 DEFINE_STANDARD_HANDLE(PartSet_ResultGroupNameFilter, SelectMgr_Filter);
  53 class PartSet_ResultGroupNameFilter: public SelectMgr_Filter
  54 {
  55 public:
  56   /// Constructor
  57   /// \param theWorkshop a pointer to workshop
  58   PartSet_ResultGroupNameFilter(ModuleBase_IWorkshop* theWorkshop)
  59     : SelectMgr_Filter(), myWorkshop(theWorkshop) {}
  60
  61   void setGroupNames(const std::set<std::string>& theGroupNames);
  62
  63   /// Returns True if selected presentation can be selected
  64   /// \param theOwner an owner of the persentation
  65   Standard_EXPORT virtual Standard_Boolean
  66     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  67
  68   DEFINE_STANDARD_RTTIEXT(PartSet_ResultGroupNameFilter, SelectMgr_Filter)
  69
  70 private:
  71   ModuleBase_IWorkshop* myWorkshop;
  72   std::set<std::string> myGroupNames;
  73 };
  74
  75 /// \class PartSet_CirclePointFilter
  76 /// \ingroup GUI
  77 /// \brief A filter which provide filtering of selection in 3d viewer.
  78 /// Installing of this filter disables selection of point on circle in sketch
  79 DEFINE_STANDARD_HANDLE(PartSet_CirclePointFilter, SelectMgr_Filter);
  80 class PartSet_CirclePointFilter: public SelectMgr_Filter
  81 {
  82 public:
  83
  84   /// Constructor
  85   /// \param theWorkshop instance of workshop interface
  86   Standard_EXPORT PartSet_CirclePointFilter(ModuleBase_IWorkshop* theWorkshop):
  87     SelectMgr_Filter(),
  88     myWorkshop(theWorkshop) {};
  89
  90   /// Returns True if the given owner is acceptable for selection
  91   /// \param theOwner the selected owner
  92   Standard_EXPORT virtual Standard_Boolean
  93     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  94
  95   DEFINE_STANDARD_RTTIEXT(PartSet_CirclePointFilter, SelectMgr_Filter)
  96
  97 private:
  98
  99   /// Reference to workshop
 100   ModuleBase_IWorkshop* myWorkshop;
 101 };
 102
 103 #endif