src/FeaturesAPI/FeaturesAPI_BooleanCommon.h

   1 // Copyright (C) 2014-2019  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                             const int theVersion = 0);
  48
  49   /// Constructor with values.
  50   FEATURESAPI_EXPORT
  51   FeaturesAPI_BooleanCommon(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  52                             const std::list<ModelHighAPI_Selection>& theMainObjects,
  53                             const std::list<ModelHighAPI_Selection>& theToolObjects,
  54                             const int theVersion = 0);
  55
  56   /// Destructor.
  57   FEATURESAPI_EXPORT
  58   virtual ~FeaturesAPI_BooleanCommon();
  59
  60   INTERFACE_3(FeaturesPlugin_BooleanCommon::ID(),
  61               creationMethod, FeaturesPlugin_BooleanCommon::CREATION_METHOD(),
  62               ModelAPI_AttributeString, /** Creation method */,
  63               mainObjects, FeaturesPlugin_BooleanCommon::OBJECT_LIST_ID(),
  64               ModelAPI_AttributeSelectionList, /** Main objects */,
  65               toolObjects, FeaturesPlugin_BooleanCommon::TOOL_LIST_ID(),
  66               ModelAPI_AttributeSelectionList, /** Tool objects*/)
  67
  68   /// Set main objects.
  69   FEATURESAPI_EXPORT
  70   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  71
  72   /// Set tool objects.
  73   FEATURESAPI_EXPORT
  74   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  75
  76   /// Set mode.
  77   FEATURESAPI_EXPORT
  78   void setAdvancedMode(const bool theMode);
  79
  80   /// Dump wrapped feature
  81   FEATURESAPI_EXPORT
  82   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  83 };
  84
  85 /// Pointer on Boolean object.
  86 typedef std::shared_ptr<FeaturesAPI_BooleanCommon> BooleanCommonPtr;
  87
  88 /// \ingroup CPPHighAPI
  89 /// \brief Create Boolean Common feature.
  90 FEATURESAPI_EXPORT BooleanCommonPtr addCommon(
  91     const std::shared_ptr<ModelAPI_Document>& part,
  92     const std::list<ModelHighAPI_Selection>& objects,
  93     const std::list<ModelHighAPI_Selection>& tools = std::list<ModelHighAPI_Selection>(),
  94     const bool keepSubResults = false);
  95
  96 #endif // FeaturesAPI_BooleanCommon_H_