src/FeaturesPlugin/FeaturesPlugin_Boolean.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 FeaturesPlugin_Cut_H_
  21 #define FeaturesPlugin_Cut_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <GeomAlgoAPI_MakeShape.h>
  26
  27 #include <ModelAPI_Feature.h>
  28
  29 /// \class FeaturesPlugin_Boolean
  30 /// \ingroup Plugins
  31 /// \brief Feature for applying of Boolean operations on Solids.
  32 /// Supports four kinds of Boolean operations: Cut, Fuse, Common and Smash.
  33 class FeaturesPlugin_Boolean : public ModelAPI_Feature
  34 {
  35 public:
  36   enum OperationType {
  37     BOOL_CUT,
  38     BOOL_FUSE,
  39     BOOL_COMMON,
  40     BOOL_FILL,
  41     BOOL_SMASH
  42   };
  43
  44   /// Feature kind.
  45   inline static const std::string& ID()
  46   {
  47     static const std::string MY_ID("Boolean");
  48     return MY_ID;
  49   }
  50
  51   /// Attribute name of main objects.
  52   inline static const std::string& OBJECT_LIST_ID()
  53   {
  54     static const std::string MY_OBJECT_LIST_ID("main_objects");
  55     return MY_OBJECT_LIST_ID;
  56   }
  57
  58   /// Attribute name of tool objects.
  59   inline static const std::string& TOOL_LIST_ID()
  60   {
  61     static const std::string MY_TOOL_LIST_ID("tool_objects");
  62     return MY_TOOL_LIST_ID;
  63   }
  64
  65   /// Attribute name of operation type.
  66   inline static const std::string& TYPE_ID()
  67   {
  68     static const std::string MY_TYPE_ID("bool_type");
  69     return MY_TYPE_ID;
  70   }
  71
  72   /// \return the kind of a feature.
  73   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  74   {
  75     static std::string MY_KIND = FeaturesPlugin_Boolean::ID();
  76     return MY_KIND;
  77   }
  78
  79   /// Creates a new part document if needed.
  80   FEATURESPLUGIN_EXPORT virtual void execute();
  81
  82   /// Request for initialization of data model of the feature: adding all attributes.
  83   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  84
  85   /// Use plugin manager for features creation.
  86   FeaturesPlugin_Boolean();
  87
  88 private:
  89   std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
  90
  91   /// Load Naming data structure of the feature to the document
  92   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  93                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
  94                     const ListOfShape& theTools,
  95                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
  96                     GeomAlgoAPI_MakeShape& theMakeShape,
  97                     GeomAPI_DataMapOfShapeShape& theMapOfShapes);
  98 };
  99
 100 #endif