src/FeaturesAPI/FeaturesAPI_BooleanFuse.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_BooleanFuse_H_
  22 #define FeaturesAPI_BooleanFuse_H_
  23
  24 #include "FeaturesAPI.h"
  25
  26 #include <FeaturesPlugin_BooleanFuse.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_BooleanFuse
  35 /// \ingroup CPPHighAPI
  36 /// \brief Interface for Boolean Fuse feature.
  37 class FeaturesAPI_BooleanFuse: public ModelHighAPI_Interface
  38 {
  39 public:
  40   /// Constructor without values.
  41   FEATURESAPI_EXPORT
  42   explicit FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  43
  44   /// Constructor with values.
  45   FEATURESAPI_EXPORT
  46     FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  47                             const std::list<ModelHighAPI_Selection>& theMainObjects,
  48                             const bool theRemoveEdges = false);
  49
  50   /// Constructor with values.
  51   FEATURESAPI_EXPORT
  52   FeaturesAPI_BooleanFuse(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  53                           const std::list<ModelHighAPI_Selection>& theMainObjects,
  54                           const std::list<ModelHighAPI_Selection>& theToolObjects,
  55                           const bool theRemoveEdges = false);
  56
  57   /// Destructor.
  58   FEATURESAPI_EXPORT
  59   virtual ~FeaturesAPI_BooleanFuse();
  60
  61   INTERFACE_4(FeaturesPlugin_BooleanFuse::ID(),
  62               creationMethod, FeaturesPlugin_BooleanFuse::CREATION_METHOD(),
  63               ModelAPI_AttributeString, /** Creation method */,
  64               mainObjects, FeaturesPlugin_BooleanFuse::OBJECT_LIST_ID(),
  65               ModelAPI_AttributeSelectionList, /** Main objects */,
  66               toolObjects, FeaturesPlugin_BooleanFuse::TOOL_LIST_ID(),
  67               ModelAPI_AttributeSelectionList, /** Tool objects*/,
  68               removeEdges, FeaturesPlugin_BooleanFuse::REMOVE_INTERSECTION_EDGES_ID(),
  69               ModelAPI_AttributeBoolean, /** Remove edges */)
  70
  71   /// Set main objects.
  72   FEATURESAPI_EXPORT
  73   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  74
  75   /// Set tool objects.
  76   FEATURESAPI_EXPORT
  77   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  78
  79   /// Set remove edges.
  80   FEATURESAPI_EXPORT
  81   void setRemoveEdges(const bool theRemoveEdges);
  82
  83   /// Set mode.
  84   FEATURESAPI_EXPORT
  85   void setAdvancedMode(const bool theMode);
  86
  87   /// Dump wrapped feature
  88   FEATURESAPI_EXPORT
  89   virtual void dump(ModelHighAPI_Dumper& theDumper) const;
  90 };
  91
  92 /// Pointer on Boolean object.
  93 typedef std::shared_ptr<FeaturesAPI_BooleanFuse> BooleanFusePtr;
  94
  95 /// \ingroup CPPHighAPI
  96 /// \brief Create Boolean Fuse feature.
  97 FEATURESAPI_EXPORT
  98 BooleanFusePtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
  99                        const std::list<ModelHighAPI_Selection>& theObjects,
 100                        const bool theRemoveEdges = false);
 101
 102 /// \ingroup CPPHighAPI
 103 /// \brief Create Boolean Fuse feature.
 104 FEATURESAPI_EXPORT
 105 BooleanFusePtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
 106                        const std::list<ModelHighAPI_Selection>& theMainObjects,
 107                        const std::list<ModelHighAPI_Selection>& theToolObjects,
 108                        const bool theRemoveEdges = false);
 109
 110 #endif // FeaturesAPI_BooleanFuse_H_