src/FeaturesPlugin/FeaturesPlugin_BooleanFuse.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_BooleanFuse_H_
  21 #define FeaturesPlugin_BooleanFuse_H_
  22
  23 #include "FeaturesPlugin_Boolean.h"
  24
  25 /// \class FeaturesPlugin_BooleanFuse
  26 /// \ingroup Plugins
  27 /// \brief Feature for applying of Boolean Fuse operation.
  28 class FeaturesPlugin_BooleanFuse : public FeaturesPlugin_Boolean
  29 {
  30 public:
  31
  32   /// Feature kind.
  33   inline static const std::string& ID()
  34   {
  35     static const std::string MY_ID("Fuse");
  36     return MY_ID;
  37   }
  38
  39   /// \return the kind of a feature.
  40   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  41   {
  42     static std::string MY_KIND = FeaturesPlugin_BooleanFuse::ID();
  43     return MY_KIND;
  44   }
  45
  46   /// Attribute name for creation method.
  47   inline static const std::string& CREATION_METHOD()
  48   {
  49     static const std::string MY_CREATION_METHOD_ID("creation_method");
  50     return MY_CREATION_METHOD_ID;
  51   }
  52
  53   /// Attribute name for creation method.
  54   inline static const std::string& CREATION_METHOD_SIMPLE()
  55   {
  56     static const std::string MY_CREATION_METHOD_ID("simple");
  57     return MY_CREATION_METHOD_ID;
  58   }
  59
  60   /// Attribute name for creation method.
  61   inline static const std::string& CREATION_METHOD_ADVANCED()
  62   {
  63     static const std::string MY_CREATION_METHOD_ID("advanced");
  64     return MY_CREATION_METHOD_ID;
  65   }
  66
  67   /// Attribute name of main objects.
  68   inline static const std::string& OBJECT_LIST_ID()
  69   {
  70     static const std::string MY_OBJECT_LIST_ID("main_objects");
  71     return MY_OBJECT_LIST_ID;
  72   }
  73
  74   /// Attribute name of tool objects.
  75   inline static const std::string& TOOL_LIST_ID()
  76   {
  77     static const std::string MY_TOOL_LIST_ID("tool_objects");
  78     return MY_TOOL_LIST_ID;
  79   }
  80
  81   /// Attribute name of remove edges option.
  82   inline static const std::string& REMOVE_INTERSECTION_EDGES_ID()
  83   {
  84     static const std::string MY_TOOL_LIST_ID("remove_intersection_edges");
  85     return MY_TOOL_LIST_ID;
  86   }
  87
  88   /// Request for initialization of data model of the feature: adding all attributes.
  89   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  90
  91   /// Performs the algorithm and stores results it in the data structure.
  92   FEATURESPLUGIN_EXPORT virtual void execute();
  93
  94 public:
  95
  96   /// Use plugin manager for features creation.
  97   FeaturesPlugin_BooleanFuse();
  98 };
  99
 100 #endif