src/FeaturesAPI/FeaturesAPI_BooleanCommon.h

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