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 email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef PartSet_Filters_H
  21 #define PartSet_Filters_H
  22
  23 #include <ModuleBase_ViewerFilters.h>
  24
  25
  26 /**
  27 * \class PartSet_GlobalFilter
  28 * \ingroup Modules
  29 * A class which filters groups object in addition to documents (see issue #310)
  30 */
  31 DEFINE_STANDARD_HANDLE(PartSet_GlobalFilter, ModuleBase_ShapeDocumentFilter);
  32 class PartSet_GlobalFilter: public ModuleBase_ShapeDocumentFilter
  33 {
  34 public:
  35   /// Constructor
  36   /// \param theWorkshop a pointer to workshop
  37   PartSet_GlobalFilter(ModuleBase_IWorkshop* theWorkshop)
  38     : ModuleBase_ShapeDocumentFilter(theWorkshop) {}
  39
  40   /// Returns True if selected presentation can be selected
  41   /// \param theOwner an owner of the persentation
  42   Standard_EXPORT virtual Standard_Boolean
  43     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  44
  45   DEFINE_STANDARD_RTTIEXT(PartSet_GlobalFilter, ModuleBase_ShapeDocumentFilter)
  46 };
  47
  48
  49 /// \class PartSet_CirclePointFilter
  50 /// \ingroup GUI
  51 /// \brief A filter which provide filtering of selection in 3d viewer.
  52 /// Installing of this filter disables selection of point on circle in sketch
  53 DEFINE_STANDARD_HANDLE(PartSet_CirclePointFilter, SelectMgr_Filter);
  54 class PartSet_CirclePointFilter: public SelectMgr_Filter
  55 {
  56 public:
  57
  58   /// Constructor
  59   /// \param theWorkshop instance of workshop interface
  60   Standard_EXPORT PartSet_CirclePointFilter(ModuleBase_IWorkshop* theWorkshop):
  61     SelectMgr_Filter(),
  62     myWorkshop(theWorkshop) {};
  63
  64   /// Returns True if the given owner is acceptable for selection
  65   /// \param theOwner the selected owner
  66   Standard_EXPORT virtual Standard_Boolean
  67     IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  68
  69   DEFINE_STANDARD_RTTIEXT(PartSet_CirclePointFilter, SelectMgr_Filter)
  70
  71 private:
  72
  73   /// Reference to workshop
  74   ModuleBase_IWorkshop* myWorkshop;
  75 };
  76
  77 #endif