src/PartSet/PartSet_Filters.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef PartSet_Filters_H
  22 #define PartSet_Filters_H
  23
  24 #include <ModuleBase_ViewerFilters.h>
  25
  26 #include <set>
  27 #include <string>
  28
  29 /**
  30 * \class PartSet_GlobalFilter
  31 * \ingroup Modules
  32 * A class which filters groups object in addition to documents (see issue #310)
  33 */
  34 DEFINE_STANDARD_HANDLE(PartSet_GlobalFilter, ModuleBase_ShapeDocumentFilter);
  35 class PartSet_GlobalFilter: public ModuleBase_ShapeDocumentFilter
  36 {
  37 public:
  38   /// Constructor
  39   /// \param theWorkshop a pointer to workshop
  40   PartSet_GlobalFilter(ModuleBase_IWorkshop* theWorkshop)
  41     : ModuleBase_ShapeDocumentFilter(theWorkshop) {}
  42
  43   /// Returns True if selected presentation can be selected
  44   /// \param theOwner an owner of the persentation
  45   Standard_EXPORT virtual Standard_Boolean
  46     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  47
  48   DEFINE_STANDARD_RTTIEXT(PartSet_GlobalFilter, ModuleBase_ShapeDocumentFilter)
  49 };
  50
  51 /// \class PartSet_ResultGroupNameFilter
  52 /// \ingroup Modules
  53 /// A class which filters results with groupName() result in filter parameters
  54 DEFINE_STANDARD_HANDLE(PartSet_ResultGroupNameFilter, SelectMgr_Filter);
  55 class PartSet_ResultGroupNameFilter: public SelectMgr_Filter
  56 {
  57 public:
  58   /// Constructor
  59   /// \param theWorkshop a pointer to workshop
  60   PartSet_ResultGroupNameFilter(ModuleBase_IWorkshop* theWorkshop)
  61     : SelectMgr_Filter(), myWorkshop(theWorkshop) {}
  62
  63   void setGroupNames(const std::set<std::string>& theGroupNames);
  64
  65   /// Returns True if selected presentation can be selected
  66   /// \param theOwner an owner of the persentation
  67   Standard_EXPORT virtual Standard_Boolean
  68     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  69
  70   DEFINE_STANDARD_RTTIEXT(PartSet_ResultGroupNameFilter, SelectMgr_Filter)
  71
  72 private:
  73   ModuleBase_IWorkshop* myWorkshop;
  74   std::set<std::string> myGroupNames;
  75 };
  76
  77 /// \class PartSet_CirclePointFilter
  78 /// \ingroup GUI
  79 /// \brief A filter which provide filtering of selection in 3d viewer.
  80 /// Installing of this filter disables selection of point on circle in sketch
  81 DEFINE_STANDARD_HANDLE(PartSet_CirclePointFilter, SelectMgr_Filter);
  82 class PartSet_CirclePointFilter: public SelectMgr_Filter
  83 {
  84 public:
  85
  86   /// Constructor
  87   /// \param theWorkshop instance of workshop interface
  88   Standard_EXPORT PartSet_CirclePointFilter(ModuleBase_IWorkshop* theWorkshop):
  89     SelectMgr_Filter(),
  90     myWorkshop(theWorkshop) {};
  91
  92   /// Returns True if the given owner is acceptable for selection
  93   /// \param theOwner the selected owner
  94   Standard_EXPORT virtual Standard_Boolean
  95     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  96
  97   DEFINE_STANDARD_RTTIEXT(PartSet_CirclePointFilter, SelectMgr_Filter)
  98
  99 private:
 100
 101   /// Reference to workshop
 102   ModuleBase_IWorkshop* myWorkshop;
 103 };
 104
 105 #endif