src/FeaturesAPI/FeaturesAPI_BooleanSmash.h

   1 // Copyright (C) 2014-2020  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 FeaturesAPI_BooleanSmash_H_
  21 #define FeaturesAPI_BooleanSmash_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_BooleanSmash.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Integer;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_BooleanSmash
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for Boolean Smash feature.
  36 class FeaturesAPI_BooleanSmash: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_BooleanSmash(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   FeaturesAPI_BooleanSmash(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                            const std::list<ModelHighAPI_Selection>& theMainObjects,
  47                            const std::list<ModelHighAPI_Selection>& theToolObjects);
  48
  49   /// Destructor.
  50   FEATURESAPI_EXPORT
  51   virtual ~FeaturesAPI_BooleanSmash();
  52
  53   INTERFACE_2(FeaturesPlugin_BooleanSmash::ID(),
  54               mainObjects, FeaturesPlugin_BooleanSmash::OBJECT_LIST_ID(),
  55               ModelAPI_AttributeSelectionList, /** Main objects */,
  56               toolObjects, FeaturesPlugin_BooleanSmash::TOOL_LIST_ID(),
  57               ModelAPI_AttributeSelectionList, /** Tool objects*/)
  58
  59   /// Set main objects.
  60   FEATURESAPI_EXPORT
  61   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  62
  63   /// Set tool objects.
  64   FEATURESAPI_EXPORT
  65   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  66
  67   /// Dump wrapped feature
  68   FEATURESAPI_EXPORT
  69   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  70 };
  71
  72 /// Pointer on Boolean object.
  73 typedef std::shared_ptr<FeaturesAPI_BooleanSmash> BooleanSmashPtr;
  74
  75 /// \ingroup CPPHighAPI
  76 /// \brief Create Boolean Smash feature.
  77 FEATURESAPI_EXPORT
  78 BooleanSmashPtr addSmash(const std::shared_ptr<ModelAPI_Document>& thePart,
  79                          const std::list<ModelHighAPI_Selection>& theMainObjects,
  80                          const std::list<ModelHighAPI_Selection>& theToolObjects,
  81                          const bool keepSubResults = false);
  82
  83 #endif // FeaturesAPI_BooleanSmash_H_