src/FeaturesPlugin/FeaturesPlugin_Union.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_Union_H_
  21 #define FeaturesPlugin_Union_H_
  22
  23 #include "FeaturesPlugin.h"
  24 #include <ModelAPI_Feature.h>
  25
  26 #include <GeomAPI_Shape.h>
  27
  28 class GeomAlgoAPI_MakeShape;
  29
  30 /// \class FeaturesPlugin_Union
  31 /// \ingroup Plugins
  32 /// \brief Feature for applying of Union operations on Shapes. Union removes shared shapes from
  33 ///        several shapes and combines them into one.
  34 class FeaturesPlugin_Union : public ModelAPI_Feature
  35 {
  36 public:
  37   /// Feature kind.
  38   inline static const std::string& ID()
  39   {
  40     static const std::string MY_ID("Union");
  41     return MY_ID;
  42   }
  43
  44   /// Attribute name of base objects.
  45   inline static const std::string& BASE_OBJECTS_ID()
  46   {
  47     static const std::string MY_BASE_OBJECTS_ID("base_objects");
  48     return MY_BASE_OBJECTS_ID;
  49   }
  50
  51   /// \return the kind of a feature.
  52   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  53   {
  54     static std::string MY_KIND = FeaturesPlugin_Union::ID();
  55     return MY_KIND;
  56   }
  57
  58   /// Creates a new part document if needed
  59   FEATURESPLUGIN_EXPORT virtual void execute();
  60
  61   /// Request for initialization of data model of the feature: adding all attributes
  62   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  63
  64   /// Use plugin manager for features creation
  65   FeaturesPlugin_Union();
  66 };
  67
  68 #endif