src/FeaturesAPI/FeaturesAPI_BooleanFuse.h

   1 // Copyright (C) 2014-2023  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 #include <ModelHighAPI_Double.h>
  30
  31 class ModelHighAPI_Integer;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_BooleanFuse
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Boolean Fuse feature.
  37 class FeaturesAPI_BooleanFuse: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                           const std::list<ModelHighAPI_Selection>& theMainObjects,
  48                           const bool theRemoveEdges = false,
  49                           const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
  50
  51   /// Constructor with values.
  52   FEATURESAPI_EXPORT
  53   FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  54                           const std::list<ModelHighAPI_Selection>& theMainObjects,
  55                           const std::list<ModelHighAPI_Selection>& theToolObjects,
  56                           const bool theRemoveEdges = false,
  57                           const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
  58
  59   /// Destructor.
  60   FEATURESAPI_EXPORT
  61   virtual ~FeaturesAPI_BooleanFuse();
  62
  63   INTERFACE_6(FeaturesPlugin_BooleanFuse::ID(),
  64               creationMethod, FeaturesPlugin_BooleanFuse::CREATION_METHOD(),
  65               ModelAPI_AttributeString, /** Creation method */,
  66               mainObjects, FeaturesPlugin_BooleanFuse::OBJECT_LIST_ID(),
  67               ModelAPI_AttributeSelectionList, /** Main objects */,
  68               toolObjects, FeaturesPlugin_BooleanFuse::TOOL_LIST_ID(),
  69               ModelAPI_AttributeSelectionList, /** Tool objects*/,
  70               removeEdges, FeaturesPlugin_BooleanFuse::REMOVE_INTERSECTION_EDGES_ID(),
  71               ModelAPI_AttributeBoolean, /** Remove edges */,
  72               useFuzzy, FeaturesPlugin_BooleanFuse::USE_FUZZY_ID(),
  73               ModelAPI_AttributeBoolean, /** Use Fuzzy parameter*/,
  74               fuzzyParam, FeaturesPlugin_BooleanFuse::FUZZY_PARAM_ID(),
  75               ModelAPI_AttributeDouble, /** Fuzzy parameter */)
  76
  77   /// Set main objects.
  78   FEATURESAPI_EXPORT
  79   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  80
  81   /// Set tool objects.
  82   FEATURESAPI_EXPORT
  83   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  84
  85   /// Set remove edges.
  86   FEATURESAPI_EXPORT
  87   void setRemoveEdges(const bool theRemoveEdges);
  88
  89   /// Set use fuzzy parameter.
  90   FEATURESAPI_EXPORT
  91   void setUseFuzzy(bool theUseFuzzy);
  92
  93   /// Set fuzzy parameter.
  94   FEATURESAPI_EXPORT
  95   void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
  96
  97   /// Set mode.
  98   FEATURESAPI_EXPORT
  99   void setAdvancedMode(const bool theMode);
 100
 101   /// Dump wrapped feature
 102   FEATURESAPI_EXPORT
 103   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
 104 };
 105
 106 /// Pointer on Boolean object.
 107 typedef std::shared_ptr<FeaturesAPI_BooleanFuse> BooleanFusePtr;
 108
 109 #define DUMMY_TOOLS std::pair<std::list<ModelHighAPI_Selection>, bool>\
 110                     (std::list<ModelHighAPI_Selection>(), false)
 111
 112 /// \ingroup CPPHighAPI
 113 /// \brief Create Boolean Fuse feature.
 114 FEATURESAPI_EXPORT BooleanFusePtr addFuse(
 115     const std::shared_ptr<ModelAPI_Document>& part,
 116     const std::list<ModelHighAPI_Selection>& objects,
 117     const std::pair<std::list<ModelHighAPI_Selection>, bool>& tools = DUMMY_TOOLS,
 118     const bool removeEdges = false,
 119     const ModelHighAPI_Double& fuzzyParam = ModelHighAPI_Double(-1),
 120     const bool keepSubResults = false);
 121
 122 #endif // FeaturesAPI_BooleanFuse_H_