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