src/FeaturesAPI/FeaturesAPI_Union.h

   1 // Copyright (C) 2014-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 FeaturesAPI_Union_H_
  21 #define FeaturesAPI_Union_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_Union.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Dumper;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_Union
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for Union feature.
  36 class FeaturesAPI_Union: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_Union(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43   /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   explicit FeaturesAPI_Union(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                              const std::list<ModelHighAPI_Selection>& theBaseObjects);
  47
  48   /// Destructor.
  49   FEATURESAPI_EXPORT
  50   virtual ~FeaturesAPI_Union();
  51
  52   INTERFACE_1(FeaturesPlugin_Union::ID(),
  53               baseObjects, FeaturesPlugin_Union::BASE_OBJECTS_ID(),
  54               ModelAPI_AttributeSelectionList, /** Base objects */)
  55
  56   /// Modify base attribute of the feature.
  57   FEATURESAPI_EXPORT
  58   void setBase(const std::list<ModelHighAPI_Selection>& theBaseObjects);
  59
  60   /// Dump wrapped feature
  61   FEATURESAPI_EXPORT
  62   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  63 };
  64
  65 /// Pointer on Union object.
  66 typedef std::shared_ptr<FeaturesAPI_Union> UnionPtr;
  67
  68 /// \ingroup CPPHighAPI
  69 /// \brief Create Union feature.
  70 FEATURESAPI_EXPORT
  71 UnionPtr addUnion(const std::shared_ptr<ModelAPI_Document>& thePart,
  72                   const std::list<ModelHighAPI_Selection>& theBaseObjects,
  73                   const bool keepSubResults = false);
  74
  75 #endif // FeaturesAPI_Union_H_