src/FeaturesAPI/FeaturesAPI_Intersection.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_Intersection_H_
  21 #define FeaturesAPI_Intersection_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_Intersection.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29 #include <ModelHighAPI_Double.h>
  30
  31 class ModelHighAPI_Dumper;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_Intersection
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Intersection feature.
  37 class FeaturesAPI_Intersection: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_Intersection(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   explicit FeaturesAPI_Intersection(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                                     const std::list<ModelHighAPI_Selection>& theObjects,
  48                                     const ModelHighAPI_Double& aFuzzy = ModelHighAPI_Double(-1));
  49
  50   /// Destructor.
  51   FEATURESAPI_EXPORT
  52   virtual ~FeaturesAPI_Intersection();
  53
  54   INTERFACE_3(FeaturesPlugin_Intersection::ID(),
  55               objects, FeaturesPlugin_Intersection::OBJECT_LIST_ID(),
  56               ModelAPI_AttributeSelectionList, /** Objects */,
  57               useFuzzy, FeaturesPlugin_Intersection::USE_FUZZY_ID(),
  58               ModelAPI_AttributeBoolean, /** Use Fuzzy parameter*/,
  59               fuzzyParam, FeaturesPlugin_Intersection::FUZZY_PARAM_ID(),
  60               ModelAPI_AttributeDouble, /** Fuzzy parameter */)
  61
  62   /// Modify objects attribute of the feature.
  63   FEATURESAPI_EXPORT
  64   void setObjects(const std::list<ModelHighAPI_Selection>& theObjects);
  65
  66   /// Set use fuzzy parameter.
  67   FEATURESAPI_EXPORT
  68   void setUseFuzzy(bool theUseFuzzy);
  69
  70   /// Set fuzzy parameter.
  71   FEATURESAPI_EXPORT
  72   void setFuzzyValue(const ModelHighAPI_Double& theFuzzy);
  73
  74   /// Dump wrapped feature
  75   FEATURESAPI_EXPORT
  76   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  77 };
  78
  79 /// Pointer on Intersection object.
  80 typedef std::shared_ptr<FeaturesAPI_Intersection> IntersectionPtr;
  81
  82 /// \ingroup CPPHighAPI
  83 /// \brief Create Intersection feature.
  84 FEATURESAPI_EXPORT
  85 IntersectionPtr addIntersection(const std::shared_ptr<ModelAPI_Document>& part,
  86                                 const std::list<ModelHighAPI_Selection>& objects,
  87                                 const ModelHighAPI_Double& fuzzyParam = ModelHighAPI_Double(-1),
  88                                 const bool keepSubResults = false);
  89
  90 #endif // FeaturesAPI_Intersection_H_