src/FeaturesAPI/FeaturesAPI_Boolean.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        FeaturesAPI_Boolean.h
   4 // Created:     07 June 2016
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef FeaturesAPI_Boolean_H_
   8 #define FeaturesAPI_Boolean_H_
   9
  10 #include "FeaturesAPI.h"
  11
  12 #include <FeaturesPlugin_Boolean.h>
  13
  14 #include <ModelHighAPI_Interface.h>
  15 #include <ModelHighAPI_Macro.h>
  16
  17 class ModelHighAPI_Integer;
  18 class ModelHighAPI_Selection;
  19
  20 /// \class FeaturesAPI_Boolean
  21 /// \ingroup CPPHighAPI
  22 /// \brief Interface for Boolean feature.
  23 class FeaturesAPI_Boolean: public ModelHighAPI_Interface
  24 {
  25 public:
  26   /// Constructor without values.
  27   FEATURESAPI_EXPORT
  28   explicit FeaturesAPI_Boolean(const std::shared_ptr<ModelAPI_Feature>& theFeature);
  29
  30   /// Constructor with values.
  31   FEATURESAPI_EXPORT
  32   FeaturesAPI_Boolean(const std::shared_ptr<ModelAPI_Feature>& theFeature,
  33                       const ModelHighAPI_Integer& theBoolType,
  34                       const std::list<ModelHighAPI_Selection>& theMainObjects,
  35                       const std::list<ModelHighAPI_Selection>& theToolObjects);
  36
  37   /// Destructor.
  38   FEATURESAPI_EXPORT
  39   virtual ~FeaturesAPI_Boolean();
  40
  41   INTERFACE_3(FeaturesPlugin_Boolean::ID(),
  42               boolType, FeaturesPlugin_Boolean::TYPE_ID(), ModelAPI_AttributeInteger, /** Operation type */,
  43               mainObjects, FeaturesPlugin_Boolean::OBJECT_LIST_ID(), ModelAPI_AttributeSelectionList, /** Main objects */,
  44               toolObjects, FeaturesPlugin_Boolean::TOOL_LIST_ID(), ModelAPI_AttributeSelectionList, /** Tool objects*/)
  45
  46   /// Set operation type.
  47   FEATURESAPI_EXPORT
  48   void setBoolType(const ModelHighAPI_Integer& theBoolType);
  49
  50   /// Set main objects.
  51   FEATURESAPI_EXPORT
  52   void setMainObjects(const std::list<ModelHighAPI_Selection>& theMainObjects);
  53
  54   /// Set tool objects.
  55   FEATURESAPI_EXPORT
  56   void setToolObjects(const std::list<ModelHighAPI_Selection>& theToolObjects);
  57 };
  58
  59 /// Pointer on Boolean object.
  60 typedef std::shared_ptr<FeaturesAPI_Boolean> BooleanPtr;
  61
  62 /// \ingroup CPPHighAPI
  63 /// \brief Create Boolean Cut feature.
  64 FEATURESAPI_EXPORT
  65 BooleanPtr addCut(const std::shared_ptr<ModelAPI_Document>& thePart,
  66                   const std::list<ModelHighAPI_Selection>& theMainObjects,
  67                   const std::list<ModelHighAPI_Selection>& theToolObjects);
  68
  69 /// \ingroup CPPHighAPI
  70 /// \brief Create Boolean Fuse feature.
  71 FEATURESAPI_EXPORT
  72 BooleanPtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
  73                    const std::list<ModelHighAPI_Selection>& theObjects);
  74
  75 /// \ingroup CPPHighAPI
  76 /// \brief Create Boolean Fuse feature.
  77 FEATURESAPI_EXPORT
  78 BooleanPtr addFuse(const std::shared_ptr<ModelAPI_Document>& thePart,
  79                    const std::list<ModelHighAPI_Selection>& theMainObjects,
  80                    const std::list<ModelHighAPI_Selection>& theToolObjects);
  81
  82 /// \ingroup CPPHighAPI
  83 /// \brief Create Boolean Common feature.
  84 FEATURESAPI_EXPORT
  85 BooleanPtr addCommon(const std::shared_ptr<ModelAPI_Document>& thePart,
  86                      const std::list<ModelHighAPI_Selection>& theMainObjects,
  87                      const std::list<ModelHighAPI_Selection>& theToolObjects);
  88
  89 #endif // FeaturesAPI_Boolean_H_