src/FeaturesAPI/FeaturesAPI_BooleanFuse.h

   1 // Copyright (C) 2014-2021  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_BooleanFuse_H_
  21 #define FeaturesAPI_BooleanFuse_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_BooleanFuse.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_BooleanFuse
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for Boolean Fuse feature.
  36 class FeaturesAPI_BooleanFuse: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                           const std::list<ModelHighAPI_Selection>& theMainObjects,
  47                           const bool theRemoveEdges = false);
  48
  49   /// Constructor with values.
  50   FEATURESAPI_EXPORT
  51   FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  52                           const std::list<ModelHighAPI_Selection>& theMainObjects,
  53                           const std::list<ModelHighAPI_Selection>& theToolObjects,
  54                           const bool theRemoveEdges = false);
  55
  56   /// Destructor.
  57   FEATURESAPI_EXPORT
  58   virtual ~FeaturesAPI_BooleanFuse();
  59
  60   INTERFACE_4(FeaturesPlugin_BooleanFuse::ID(),
  61               creationMethod, FeaturesPlugin_BooleanFuse::CREATION_METHOD(),
  62               ModelAPI_AttributeString, /** Creation method */,
  63               mainObjects, FeaturesPlugin_BooleanFuse::OBJECT_LIST_ID(),
  64               ModelAPI_AttributeSelectionList, /** Main objects */,
  65               toolObjects, FeaturesPlugin_BooleanFuse::TOOL_LIST_ID(),
  66               ModelAPI_AttributeSelectionList, /** Tool objects*/,
  67               removeEdges, FeaturesPlugin_BooleanFuse::REMOVE_INTERSECTION_EDGES_ID(),
  68               ModelAPI_AttributeBoolean, /** Remove edges */)
  69
  70   /// Set main objects.
  71   FEATURESAPI_EXPORT
  72   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  73
  74   /// Set tool objects.
  75   FEATURESAPI_EXPORT
  76   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  77
  78   /// Set remove edges.
  79   FEATURESAPI_EXPORT
  80   void setRemoveEdges(const bool theRemoveEdges);
  81
  82   /// Set mode.
  83   FEATURESAPI_EXPORT
  84   void setAdvancedMode(const bool theMode);
  85
  86   /// Dump wrapped feature
  87   FEATURESAPI_EXPORT
  88   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  89 };
  90
  91 /// Pointer on Boolean object.
  92 typedef std::shared_ptr<FeaturesAPI_BooleanFuse> BooleanFusePtr;
  93
  94 #define DUMMY_TOOLS std::pair<std::list<ModelHighAPI_Selection>, bool>\
  95                     (std::list<ModelHighAPI_Selection>(), false)
  96
  97 /// \ingroup CPPHighAPI
  98 /// \brief Create Boolean Fuse feature.
  99 FEATURESAPI_EXPORT BooleanFusePtr addFuse(
 100     const std::shared_ptr<ModelAPI_Document>& part,
 101     const std::list<ModelHighAPI_Selection>& objects,
 102     const std::pair<std::list<ModelHighAPI_Selection>, bool>& tools = DUMMY_TOOLS,
 103     const bool removeEdges = false,
 104     const bool keepSubResults = false);
 105
 106 #endif // FeaturesAPI_BooleanFuse_H_