src/FeaturesAPI/FeaturesAPI_SharedFaces.h

   1 // Copyright (C) 2018-2021  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_SharedFaces_H_
  21 #define FeaturesAPI_SharedFaces_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include "FeaturesPlugin_GroupSharedFaces.h"
  26
  27 #include <ModelHighAPI_Integer.h>
  28 #include <ModelHighAPI_Interface.h>
  29 #include <ModelHighAPI_Macro.h>
  30
  31 class ModelAPI_Document;
  32 class ModelHighAPI_Selection;
  33
  34 /// \class FeaturesAPI_SharedFaces
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface to find shared faces
  37 class FeaturesAPI_SharedFaces: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_SharedFaces(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   FEATURESAPI_EXPORT
  45   explicit FeaturesAPI_SharedFaces(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                                    const ModelHighAPI_Selection& theObject,
  47                                    const std::string & theNameGroup);
  48
  49   /// Destructor.
  50   FEATURESAPI_EXPORT
  51   virtual ~FeaturesAPI_SharedFaces();
  52
  53   INTERFACE_2(FeaturesPlugin_GroupSharedFaces::ID(),
  54               objectselected, FeaturesPlugin_GroupSharedFaces::OBJECT_ID(),
  55               ModelAPI_AttributeSelection, /** object selected*/,
  56               groupname, FeaturesPlugin_GroupSharedFaces::GROUP_NAME_ID(),
  57               ModelAPI_AttributeString, /** group name*/)
  58
  59   /// Dump wrapped feature
  60   FEATURESAPI_EXPORT
  61   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  62 };
  63
  64 /// Pointer on the SharedFaces object.
  65 typedef std::shared_ptr<FeaturesAPI_SharedFaces> SharedFacesPtr;
  66
  67 /// \ingroup CPPHighAPI
  68 /// \brief Create a group of shared faces in a compsolid or a compound
  69 /// \param thePart the part
  70 /// \param theObject the selected object
  71 /// \param theNameGroup the group name
  72 FEATURESAPI_EXPORT
  73 SharedFacesPtr getSharedFaces(const std::shared_ptr<ModelAPI_Document>& thePart,
  74                               const ModelHighAPI_Selection& theObject,
  75                               const std::string & theNameGroup);
  76
  77 #endif // FeaturesAPI_SharedFaces_H_