src/FeaturesPlugin/FeaturesPlugin_GlueFaces.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 FeaturesPlugin_GlueFaces_H_
  21 #define FeaturesPlugin_GlueFaces_H_
  22
  23 #include "FeaturesPlugin.h"
  24
  25 #include <ModelAPI_Feature.h>
  26 #include <GeomAPI_Shape.h>
  27
  28
  29 /// \class FeaturesPlugin_GlueFaces
  30 /// \ingroup Plugins
  31 /// \brief Feature to glue duplicated faces.
  32 class FeaturesPlugin_GlueFaces : public ModelAPI_Feature
  33 {
  34 public:
  35   /// Use plugin manager for features creation
  36   FeaturesPlugin_GlueFaces();
  37
  38   /// Feature kind.
  39   inline static const std::string& ID()
  40   {
  41     static const std::string MY_ID("GlueFaces");
  42     return MY_ID;
  43   }
  44
  45   /// \return the kind of a feature.
  46   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  47   {
  48     static std::string MY_KIND = FeaturesPlugin_GlueFaces::ID();
  49     return MY_KIND;
  50   }
  51
  52   /// Attribute name of referenced objects.
  53   inline static const std::string& OBJECTS_LIST_ID()
  54   {
  55     static const std::string MY_OBJECTS_LIST_ID("main_objects");
  56     return MY_OBJECTS_LIST_ID;
  57   }
  58
  59   /// Attribute name for tolerance.
  60   inline static const std::string& TOLERANCE_ID()
  61   {
  62     static const std::string MY_TOLERANCE_ID("tolerance");
  63     return MY_TOLERANCE_ID;
  64   }
  65
  66   /// Attribute name for keeping non-solid shapes.
  67   inline static const std::string& KEEP_NON_SOLIDS_ID()
  68   {
  69     static const std::string MY_KEEP_NON_SOLIDS_ID("keep_non_solids");
  70     return MY_KEEP_NON_SOLIDS_ID;
  71   }
  72
  73   /// Request for initialization of data model of the feature: adding all attributes.
  74   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  75
  76   /// Executes the faces fusion and stores the modififed shape.
  77   FEATURESPLUGIN_EXPORT virtual void execute();
  78
  79 private:
  80   /// Retrieve all shapes from the selection list
  81   void getOriginalShapes(const std::string& theAttributeName,
  82                          ListOfShape&       theShapes);
  83
  84   /// Check, whether the result is glued or not
  85   bool isGlued(const ListOfShape& theInputs,
  86                const GeomShapePtr theResult);
  87
  88   /// Create a compound result object from the unchanged input shapes
  89   void setResultFromInput(const ListOfShape& theInputs);
  90 };
  91
  92 #endif // FeaturesPlugin_GlueFaces_H_