src/FeaturesPlugin/FeaturesPlugin_Boolean.h

   1 // Copyright (C) 2014-2019  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_Boolean_H_
  21 #define FeaturesPlugin_Boolean_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   /// Attribute name of main objects.
  45   inline static const std::string& OBJECT_LIST_ID()
  46   {
  47     static const std::string MY_OBJECT_LIST_ID("main_objects");
  48     return MY_OBJECT_LIST_ID;
  49   }
  50
  51   /// Attribute name of tool objects.
  52   inline static const std::string& TOOL_LIST_ID()
  53   {
  54     static const std::string MY_TOOL_LIST_ID("tool_objects");
  55     return MY_TOOL_LIST_ID;
  56   }
  57
  58   /// \return boolean operation type.
  59   FEATURESPLUGIN_EXPORT OperationType operationType();
  60
  61   /// Request for initialization of data model of the feature: adding all attributes.
  62   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  63
  64 protected:
  65
  66   /// Use plugin manager for features creation.
  67   FeaturesPlugin_Boolean(const OperationType theOperationType);
  68
  69   /// Load Naming data structure of the feature to the document
  70   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  71                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
  72                     const ListOfShape& theTools,
  73                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
  74                     const GeomMakeShapePtr& theMakeShape);
  75
  76 private:
  77   OperationType myOperationType;
  78 };
  79
  80 #endif