src/FeaturesPlugin/FeaturesPlugin_Defeaturing.h

   1 // Copyright (C) 2020-2022  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 FeaturesPlugin_Defeaturing_H_
  21 #define FeaturesPlugin_Defeaturing_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26
  27 class GeomAlgoAPI_MakeShape;
  28 class GeomAPI_Shape;
  29
  30 /// \class FeaturesPlugin_Defeaturing
  31 /// \ingroup Plugins
  32 /// \brief Feature for the removal of the unwanted parts or features from the model.
  33 class FeaturesPlugin_Defeaturing : public ModelAPI_Feature
  34 {
  35 public:
  36   /// Feature kind.
  37   inline static const std::string& ID()
  38   {
  39     static const std::string MY_ID("Defeaturing");
  40     return MY_ID;
  41   }
  42
  43   /// \return the kind of a feature.
  44   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  45   {
  46     static std::string MY_KIND = FeaturesPlugin_Defeaturing::ID();
  47     return MY_KIND;
  48   }
  49
  50   /// Attribute name of main objects.
  51   inline static const std::string& OBJECT_LIST_ID()
  52   {
  53     static const std::string MY_OBJECT_LIST_ID("main_objects");
  54     return MY_OBJECT_LIST_ID;
  55   }
  56
  57   /// Performs the defeaturing algorithm and stores it in the data structure.
  58   FEATURESPLUGIN_EXPORT virtual void execute();
  59
  60   /// Request for initialization of data model of the feature: adding all attributes.
  61   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  62
  63   /// Use plugin manager for features creation.
  64   FeaturesPlugin_Defeaturing();
  65
  66 private:
  67   /// Load Naming data structure of the feature to the document
  68   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  69                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
  70                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
  71                     const std::shared_ptr<GeomAlgoAPI_MakeShape>& theMakeShape);
  72 };
  73
  74 #endif