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