src/ModelAPI/ModelAPI_FiltersFactory.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 ModelAPI_FiltersFactory_H_
  21 #define ModelAPI_FiltersFactory_H_
  22
  23 #include "ModelAPI_Feature.h"
  24 #include "ModelAPI_Filter.h"
  25 #include "ModelAPI_ResultBody.h"
  26
  27 #include <GeomAPI_Shape.h>
  28
  29
  30 /**\class ModelAPI_FiltersFactory
  31 * \ingroup DataModel
  32 * \brief Manages registering of filters
  33 */
  34 class ModelAPI_FiltersFactory
  35 {
  36 public:
  37   virtual ~ModelAPI_FiltersFactory() {}
  38
  39   /// Register an instance of a filter
  40   /// \param theID unique identifier of the filter, not necessary equal to the name of filter
  41   /// \param theFilter the filter's instance
  42   virtual void registerFilter(const std::string& theID, ModelAPI_Filter* theFilter) = 0;
  43
  44   /// Returns true if all filters of the Filters feature are ok for the Shape (taking into account
  45   /// the Reversed states).
  46   /// \param theFiltersFeature feature that contains all information about the filters
  47   /// \param theResult parent result of the shape to check
  48   /// \param theShape the checked shape
  49   virtual bool isValid(FeaturePtr theFiltersFeature,
  50                        ResultPtr theResult,
  51                        GeomShapePtr theShape) = 0;
  52
  53   /// Returns the filters that support the given shape type
  54   virtual std::list<FilterPtr> filters(GeomAPI_Shape::ShapeType theType) = 0;
  55
  56   /// Returns a filter by ID
  57   virtual FilterPtr filter(std::string theID) = 0;
  58
  59   /// Returns a filter ID by the filter pointer
  60   virtual std::string id(FilterPtr theFilter) = 0;
  61
  62 protected:
  63   /// Get instance from Session
  64   ModelAPI_FiltersFactory() {}
  65 };
  66
  67 #endif