src/CollectionAPI/CollectionAPI_GroupSubstraction.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 CollectionAPI_GroupSubstraction_H_
  21 #define CollectionAPI_GroupSubstraction_H_
  22
  23 #include "CollectionAPI.h"
  24
  25 #include <CollectionPlugin_GroupSubstraction.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Dumper;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class CollectionAPI_GroupSubstraction
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for Group Intersection feature.
  36 class CollectionAPI_GroupSubstraction : public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   COLLECTIONAPI_EXPORT
  41   explicit CollectionAPI_GroupSubstraction(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   COLLECTIONAPI_EXPORT
  45   CollectionAPI_GroupSubstraction(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                                   const std::list<ModelHighAPI_Selection>& theObjectsList,
  47                                   const std::list<ModelHighAPI_Selection>& theToolsList);
  48
  49   /// Destructor.
  50   COLLECTIONAPI_EXPORT
  51   virtual ~CollectionAPI_GroupSubstraction();
  52
  53   INTERFACE_2(CollectionPlugin_GroupSubstraction::ID(),
  54               objectsList, CollectionPlugin_GroupSubstraction::LIST_ID(),
  55               ModelAPI_AttributeSelectionList, /** Objects list*/,
  56               toolsList, CollectionPlugin_GroupSubstraction::TOOLS_ID(),
  57               ModelAPI_AttributeSelectionList, /** Tools list*/)
  58
  59   /// Set main objects.
  60   COLLECTIONAPI_EXPORT
  61   void setObjectsList(const std::list<ModelHighAPI_Selection>& theGroupList);
  62
  63   /// Set tools.
  64   COLLECTIONAPI_EXPORT
  65   void setToolsList(const std::list<ModelHighAPI_Selection>& theGroupList);
  66
  67   /// Dump wrapped feature
  68   COLLECTIONAPI_EXPORT
  69   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  70 };
  71
  72 /// Pointer on Group Addition object.
  73 typedef std::shared_ptr<CollectionAPI_GroupSubstraction> GroupSubstractionPtr;
  74
  75 /// \ingroup CPPHighAPI
  76 /// \brief Create Group Substraction feature.
  77 COLLECTIONAPI_EXPORT
  78 GroupSubstractionPtr addGroupSubstraction(const std::shared_ptr<ModelAPI_Document>& thePart,
  79                                           const std::list<ModelHighAPI_Selection>& theObjectsList,
  80                                           const std::list<ModelHighAPI_Selection>& theToolsList);
  81
  82 #endif // CollectionAPI_GroupSubstraction_H_