src/FeaturesPlugin/FeaturesPlugin_BooleanCut.h

   1 // Copyright (C) 2014-2022  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 FeaturesPlugin_BooleanCut_H_
  21 #define FeaturesPlugin_BooleanCut_H_
  22
  23 #include "FeaturesPlugin_Boolean.h"
  24
  25 #include <ModelAPI_Feature.h>
  26 #include <ModelAPI_ResultBody.h>
  27
  28 /// \class FeaturesPlugin_BooleanCut
  29 /// \ingroup Plugins
  30 /// \brief Feature for applying of Boolean Cut operation.
  31 class FeaturesPlugin_BooleanCut: public FeaturesPlugin_Boolean
  32 {
  33 public:
  34
  35   /// Feature kind.
  36   inline static const std::string& ID()
  37   {
  38     static const std::string MY_ID("Cut");
  39     return MY_ID;
  40   }
  41
  42   /// \return the kind of a feature.
  43   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  44   {
  45     static std::string MY_KIND = FeaturesPlugin_BooleanCut::ID();
  46     return MY_KIND;
  47   }
  48
  49   /// Request for initialization of data model of the feature: adding all attributes.
  50   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  51
  52   /// Performs the algorithm and stores results it in the data structure.
  53   FEATURESPLUGIN_EXPORT virtual void execute();
  54
  55 public:
  56
  57   /// Use plugin manager for features creation.
  58   FeaturesPlugin_BooleanCut();
  59
  60 };
  61
  62 #endif