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