src/FeaturesAPI/FeaturesAPI_Sewing.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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_SEWING_H_
  21 #define FEATURESAPI_SEWING_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_Sewing.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Double;
  31 class ModelHighAPI_Dumper;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_Sewing
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Sewing feature.
  37 class FeaturesAPI_Sewing: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_Sewing(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   explicit FeaturesAPI_Sewing(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                               const std::list<ModelHighAPI_Selection>& theMainObjects,
  48                               const ModelHighAPI_Double& theTolerance,
  49                               bool theIsAllowNonManifold = false,
  50                               bool theIsAlwaysCreateResult = true);
  51
  52   /// Destructor.
  53   FEATURESAPI_EXPORT
  54   virtual ~FeaturesAPI_Sewing();
  55
  56   INTERFACE_4(FeaturesPlugin_Sewing::ID(),
  57               mainObjects, FeaturesPlugin_Sewing::OBJECTS_LIST_ID(),
  58               ModelAPI_AttributeSelectionList, /** Main objects */,
  59               tolerance, FeaturesPlugin_Sewing::TOLERANCE_ID(),
  60               ModelAPI_AttributeDouble, /** Tolerance */,
  61               isAllowNonManifold, FeaturesPlugin_Sewing::ALLOW_NON_MANIFOLD_ID(),
  62               ModelAPI_AttributeBoolean, /** Allow Non-Manifold Shapes */,
  63               isAlwaysCreateResult, FeaturesPlugin_Sewing::ALWAYS_CREATE_RESULT_ID(),
  64               ModelAPI_AttributeBoolean, /** Always Create Result */)
  65
  66   /// Set main objects.
  67   FEATURESAPI_EXPORT
  68   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  69
  70   /// Set the tolerance.
  71   FEATURESAPI_EXPORT
  72   void setTolerance(const ModelHighAPI_Double& theTolerance);
  73
  74   /// Set flag whether to allow non-manifold results.
  75   FEATURESAPI_EXPORT
  76   void setIsAllowNonManifold(bool theFlag);
  77
  78   /// Set flag whether to always create a result.
  79   FEATURESAPI_EXPORT
  80   void setIsAlwaysCreateResult(bool theFlag);
  81
  82   /// Dump wrapped feature
  83   FEATURESAPI_EXPORT
  84   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  85 };
  86
  87 /// Pointer on Sewing object.
  88 typedef std::shared_ptr<FeaturesAPI_Sewing> SewingPtr;
  89
  90 /// \ingroup CPPHighAPI
  91 /// \brief Create Sewing feature.
  92 FEATURESAPI_EXPORT SewingPtr addSewing(
  93     const std::shared_ptr<ModelAPI_Document>& thePart,
  94     const std::list<ModelHighAPI_Selection>& theMainObjects,
  95     const ModelHighAPI_Double& theTolerance,
  96     const bool allowNonManifold,
  97     const bool alwaysCreateResult);
  98
  99 #endif // FEATURESAPI_SEWING_H_