src/FeaturesAPI/FeaturesAPI_Boolean.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_Boolean_H_
  22 #define FeaturesAPI_Boolean_H_
  23
  24 #include "FeaturesAPI.h"
  25
  26 #include <FeaturesPlugin_Boolean.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_Boolean
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Boolean feature.
  37 class FeaturesAPI_Boolean: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_Boolean(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46   FeaturesAPI_Boolean(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                       const ModelHighAPI_Integer& theBoolType,
  48                       const std::list<ModelHighAPI_Selection>& theMainObjects,
  49                       const std::list<ModelHighAPI_Selection>& theToolObjects);
  50
  51   /// Destructor.
  52   FEATURESAPI_EXPORT
  53   virtual ~FeaturesAPI_Boolean();
  54
  55   INTERFACE_3(FeaturesPlugin_Boolean::ID(),
  56               boolType, FeaturesPlugin_Boolean::TYPE_ID(),
  57               ModelAPI_AttributeInteger, /** Operation type */,
  58               mainObjects, FeaturesPlugin_Boolean::OBJECT_LIST_ID(),
  59               ModelAPI_AttributeSelectionList, /** Main objects */,
  60               toolObjects, FeaturesPlugin_Boolean::TOOL_LIST_ID(),
  61               ModelAPI_AttributeSelectionList, /** Tool objects*/)
  62
  63   /// Set operation type.
  64   FEATURESAPI_EXPORT
  65   void setBoolType(const ModelHighAPI_Integer& theBoolType);
  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   /// Dump wrapped feature
  76   FEATURESAPI_EXPORT
  77   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  78 };
  79
  80 /// Pointer on Boolean object.
  81 typedef std::shared_ptr<FeaturesAPI_Boolean> BooleanPtr;
  82
  83 /// \ingroup CPPHighAPI
  84 /// \brief Create Boolean Cut feature.
  85 FEATURESAPI_EXPORT
  86 BooleanPtr addCut(const std::shared_ptr<ModelAPI_Document>& thePart,
  87                   const std::list<ModelHighAPI_Selection>& theMainObjects,
  88                   const std::list<ModelHighAPI_Selection>& theToolObjects);
  89
  90 /// \ingroup CPPHighAPI
  91 /// \brief Create Boolean Fuse feature.
  92 FEATURESAPI_EXPORT
  93 BooleanPtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
  94                    const std::list<ModelHighAPI_Selection>& theObjects);
  95
  96 /// \ingroup CPPHighAPI
  97 /// \brief Create Boolean Fuse feature.
  98 FEATURESAPI_EXPORT
  99 BooleanPtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
 100                    const std::list<ModelHighAPI_Selection>& theMainObjects,
 101                    const std::list<ModelHighAPI_Selection>& theToolObjects);
 102
 103 /// \ingroup CPPHighAPI
 104 /// \brief Create Boolean Common feature.
 105 FEATURESAPI_EXPORT
 106 BooleanPtr addCommon(const std::shared_ptr<ModelAPI_Document>& thePart,
 107                      const std::list<ModelHighAPI_Selection>& theMainObjects,
 108                      const std::list<ModelHighAPI_Selection>& theToolObjects);
 109
 110 /// \ingroup CPPHighAPI
 111 /// \brief Create Boolean Smash feature.
 112 FEATURESAPI_EXPORT
 113 BooleanPtr addSmash(const std::shared_ptr<ModelAPI_Document>& thePart,
 114                     const std::list<ModelHighAPI_Selection>& theMainObjects,
 115                     const std::list<ModelHighAPI_Selection>& theToolObjects);
 116
 117 /// \ingroup CPPHighAPI
 118 /// \brief Create Boolean Fill feature.
 119 FEATURESAPI_EXPORT
 120 BooleanPtr addFill(const std::shared_ptr<ModelAPI_Document>& thePart,
 121                    const std::list<ModelHighAPI_Selection>& theMainObjects,
 122                    const std::list<ModelHighAPI_Selection>& theToolObjects);
 123
 124 #endif // FeaturesAPI_Boolean_H_