src/FeaturesPlugin/FeaturesPlugin_BooleanCut.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 FeaturesPlugin_BooleanCut_H_
  22 #define FeaturesPlugin_BooleanCut_H_
  23
  24 #include "FeaturesPlugin_Boolean.h"
  25
  26 #include <ModelAPI_Feature.h>
  27 #include <ModelAPI_ResultBody.h>
  28
  29 /// \class FeaturesPlugin_BooleanCut
  30 /// \ingroup Plugins
  31 /// \brief Feature for applying of Boolean Cut operation.
  32 class FeaturesPlugin_BooleanCut: public FeaturesPlugin_Boolean
  33 {
  34 public:
  35
  36   /// Feature kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("Cut");
  40     return MY_ID;
  41   }
  42
  43   /// \return the kind of a feature.
  44   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  45   {
  46     static std::string MY_KIND = FeaturesPlugin_BooleanCut::ID();
  47     return MY_KIND;
  48   }
  49
  50   /// Creates a new part document if needed.
  51   FEATURESPLUGIN_EXPORT virtual void execute();
  52
  53 public:
  54
  55   /// Use plugin manager for features creation.
  56   FeaturesPlugin_BooleanCut();
  57
  58 private:
  59
  60   /// Load Naming data structure of the feature to the document
  61   void loadNamingDS(ResultBodyPtr theResultBody,
  62                     const GeomShapePtr theBaseShape,
  63                     const ListOfShape& theTools,
  64                     const GeomShapePtr theResultShape,
  65                     GeomAlgoAPI_MakeShape& theMakeShape,
  66                     GeomAPI_DataMapOfShapeShape& theMapOfShapes,
  67                     const bool theIsStoreAsGenerated = false);
  68
  69 };
  70
  71 #endif