src/FeaturesAPI/FeaturesAPI_BooleanCommon.h

   1 // Copyright (C) 2014-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_BooleanCommon_H_
  21 #define FeaturesAPI_BooleanCommon_H_
  22
  23 #include "FeaturesAPI.h"
  24
  25 #include <FeaturesPlugin_BooleanCommon.h>
  26
  27 #include <ModelHighAPI_Interface.h>
  28 #include <ModelHighAPI_Macro.h>
  29
  30 class ModelHighAPI_Integer;
  31 class ModelHighAPI_Selection;
  32
  33 /// \class FeaturesAPI_BooleanCommon
  34 /// \ingroup CPPHighAPI
  35 /// \brief Interface for Boolean Common feature.
  36 class FeaturesAPI_BooleanCommon: public ModelHighAPI_Interface
  37 {
  38 public:
  39   /// Constructor without values.
  40   FEATURESAPI_EXPORT
  41   explicit FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  42
  43     /// Constructor with values.
  44   FEATURESAPI_EXPORT
  45   FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  46                             const std::list<ModelHighAPI_Selection>& theMainObjects);
  47
  48   /// Constructor with values.
  49   FEATURESAPI_EXPORT
  50   FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  51                             const std::list<ModelHighAPI_Selection>& theMainObjects,
  52                             const std::list<ModelHighAPI_Selection>& theToolObjects);
  53
  54   /// Destructor.
  55   FEATURESAPI_EXPORT
  56   virtual ~FeaturesAPI_BooleanCommon();
  57
  58   INTERFACE_3(FeaturesPlugin_BooleanCommon::ID(),
  59               creationMethod, FeaturesPlugin_BooleanCommon::CREATION_METHOD(),
  60               ModelAPI_AttributeString, /** Creation method */,
  61               mainObjects, FeaturesPlugin_BooleanCommon::OBJECT_LIST_ID(),
  62               ModelAPI_AttributeSelectionList, /** Main objects */,
  63               toolObjects, FeaturesPlugin_BooleanCommon::TOOL_LIST_ID(),
  64               ModelAPI_AttributeSelectionList, /** Tool objects*/)
  65
  66   /// Set main objects.
  67   FEATURESAPI_EXPORT
  68   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  69
  70   /// Set tool objects.
  71   FEATURESAPI_EXPORT
  72   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  73
  74   /// Set mode.
  75   FEATURESAPI_EXPORT
  76   void setAdvancedMode(const bool theMode);
  77
  78   /// Dump wrapped feature
  79   FEATURESAPI_EXPORT
  80   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  81 };
  82
  83 /// Pointer on Boolean object.
  84 typedef std::shared_ptr<FeaturesAPI_BooleanCommon> BooleanCommonPtr;
  85
  86 /// \ingroup CPPHighAPI
  87 /// \brief Create Boolean Common feature.
  88 FEATURESAPI_EXPORT BooleanCommonPtr addCommon(
  89     const std::shared_ptr<ModelAPI_Document>& part,
  90     const std::list<ModelHighAPI_Selection>& objects,
  91     const std::list<ModelHighAPI_Selection>& tools = std::list<ModelHighAPI_Selection>(),
  92     const bool keepSubResults = false);
  93
  94 #endif // FeaturesAPI_BooleanCommon_H_