src/FeaturesAPI/FeaturesAPI_BooleanCut.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_BooleanCut_H_
  21 #define FeaturesAPI_BooleanCut_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_BooleanCut.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_BooleanCut
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Boolean Cut feature.
  37 class FeaturesAPI_BooleanCut: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_BooleanCut(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   FeaturesAPI_BooleanCut(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                          const std::list<ModelHighAPI_Selection>& theMainObjects,
  48                          const std::list<ModelHighAPI_Selection>& theToolObjects,
  49                          const ModelHighAPI_Double& theFuzzy = ModelHighAPI_Double(-1));
  50
  51   /// Destructor.
  52   FEATURESAPI_EXPORT
  53   virtual ~FeaturesAPI_BooleanCut();
  54
  55   INTERFACE_4(FeaturesPlugin_BooleanCut::ID(),
  56               mainObjects, FeaturesPlugin_BooleanCut::OBJECT_LIST_ID(),
  57               ModelAPI_AttributeSelectionList, /** Main objects */,
  58               toolObjects, FeaturesPlugin_BooleanCut::TOOL_LIST_ID(),
  59               ModelAPI_AttributeSelectionList, /** Tool objects*/,
  60               useFuzzy, FeaturesPlugin_BooleanCut::USE_FUZZY_ID(),
  61               ModelAPI_AttributeBoolean, /** Use Fuzzy parameter*/,
  62               fuzzyParam, FeaturesPlugin_BooleanCut::FUZZY_PARAM_ID(),
  63               ModelAPI_AttributeDouble, /** Fuzzy parameter */)
  64
  65   /// Set main objects.
  66   FEATURESAPI_EXPORT
  67   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  68
  69   /// Set tool objects.
  70   FEATURESAPI_EXPORT
  71   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  72
  73   /// Set use fuzzy parameter.
  74   FEATURESAPI_EXPORT
  75   void setUseFuzzy(bool theUseFuzzy);
  76
  77   /// Set fuzzy parameter.
  78   FEATURESAPI_EXPORT
  79   void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
  80
  81   /// Dump wrapped feature
  82   FEATURESAPI_EXPORT
  83   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  84 };
  85
  86 /// Pointer on Boolean object.
  87 typedef std::shared_ptr<FeaturesAPI_BooleanCut> BooleanCutPtr;
  88
  89 /// \ingroup CPPHighAPI
  90 /// \brief Create Boolean Cut feature.
  91 FEATURESAPI_EXPORT
  92 BooleanCutPtr addCut(const std::shared_ptr<ModelAPI_Document>& thePart,
  93                      const std::list<ModelHighAPI_Selection>& theMainObjects,
  94                      const std::list<ModelHighAPI_Selection>& theToolObjects,
  95                      const ModelHighAPI_Double& fuzzyParam = ModelHighAPI_Double(-1),
  96                      const bool keepSubResults = false);
  97
  98 #endif // FeaturesAPI_BooleanCut_H_