src/FeaturesPlugin/FeaturesPlugin_BooleanCommon.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_BooleanCommon_H_
  22 #define FeaturesPlugin_BooleanCommon_H_
  23
  24 #include "FeaturesPlugin_Boolean.h"
  25
  26 #include <ModelAPI_ResultBody.h>
  27
  28 /// \class FeaturesPlugin_BooleanCommon
  29 /// \ingroup Plugins
  30 /// \brief Feature for applying of Boolean Common operation.
  31 class FeaturesPlugin_BooleanCommon : 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("Common");
  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_BooleanCommon::ID();
  46     return MY_KIND;
  47   }
  48
  49   /// Attribute name for creation method.
  50   inline static const std::string& CREATION_METHOD()
  51   {
  52     static const std::string MY_CREATION_METHOD_ID("creation_method");
  53     return MY_CREATION_METHOD_ID;
  54   }
  55
  56   /// Attribute name for creation method.
  57   inline static const std::string& CREATION_METHOD_SIMPLE()
  58   {
  59     static const std::string MY_CREATION_METHOD_ID("simple");
  60     return MY_CREATION_METHOD_ID;
  61   }
  62
  63   /// Attribute name for creation method.
  64   inline static const std::string& CREATION_METHOD_ADVANCED()
  65   {
  66     static const std::string MY_CREATION_METHOD_ID("advanced");
  67     return MY_CREATION_METHOD_ID;
  68   }
  69
  70   /// Attribute name of main objects.
  71   inline static const std::string& OBJECT_LIST_ID()
  72   {
  73     static const std::string MY_OBJECT_LIST_ID("main_objects");
  74     return MY_OBJECT_LIST_ID;
  75   }
  76
  77   /// Attribute name of tool objects.
  78   inline static const std::string& TOOL_LIST_ID()
  79   {
  80     static const std::string MY_TOOL_LIST_ID("tool_objects");
  81     return MY_TOOL_LIST_ID;
  82   }
  83
  84   /// Request for initialization of data model of the feature: adding all attributes.
  85   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  86
  87   /// Creates a new part document if needed.
  88   FEATURESPLUGIN_EXPORT virtual void execute();
  89
  90 public:
  91
  92   /// Use plugin manager for features creation.
  93   FeaturesPlugin_BooleanCommon();
  94
  95 private:
  96
  97   /// Load Naming data structure of the feature to the document
  98   void loadNamingDS(ResultBodyPtr theResultBody,
  99                     const GeomShapePtr theBaseShape,
 100                     const ListOfShape& theTools,
 101                     const GeomShapePtr theResultShape,
 102                     GeomAlgoAPI_MakeShape& theMakeShape,
 103                     GeomAPI_DataMapOfShapeShape& theMapOfShapes);
 104
 105 };
 106
 107 #endif