src/ModuleBase/ModuleBase_FilterValidated.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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 ModuleBase_FilterValidated_H
  21 #define ModuleBase_FilterValidated_H
  22
  23 #include <SelectMgr_Filter.hxx>
  24 #include <SelectMgr_EntityOwner.hxx>
  25
  26 class ModuleBase_IWorkshop;
  27
  28 //#define DEBUG_FILTERS
  29
  30 /**
  31 * \ingroup GUI
  32 * \class ModuleBase_FilterValidated
  33 * A filter which provides filtering of selection in 3d viewer.
  34 * Installing of this filter lets to select objects which belong to
  35 * currently active document or to global document
  36 */
  37 DEFINE_STANDARD_HANDLE(ModuleBase_FilterValidated, SelectMgr_Filter);
  38 class ModuleBase_FilterValidated: public SelectMgr_Filter
  39 {
  40 public:
  41   /// Constructor
  42   /// \param theWorkshop instance of workshop interface
  43   Standard_EXPORT ModuleBase_FilterValidated(ModuleBase_IWorkshop* theWorkshop):
  44       SelectMgr_Filter(), myWorkshop(theWorkshop) {}
  45
  46   /**
  47    * Returns true if the owner is computed from decomposition
  48    * (it is global selection, not the sub-shapes)
  49    * of if the selected result is a construction and the result
  50    * feature is composite and has sub-elements.
  51    * \param theOwner the result of selection
  52    * \return whether the owner is selectable in the viewer
  53   */
  54   Standard_EXPORT virtual
  55     Standard_Boolean IsOk(const Handle(SelectMgr_EntityOwner)& theOwner) const;
  56
  57   DEFINE_STANDARD_RTTIEXT(ModuleBase_FilterValidated, SelectMgr_Filter)
  58 protected:
  59   /// Instance of workshop interface
  60   ModuleBase_IWorkshop* myWorkshop;
  61 };
  62
  63 #endif