src/FeaturesPlugin/FeaturesPlugin_Partition.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        FeaturesPlugin_Partition.h
   4 // Created:     31 Jul 2015
   5 // Author:      Natalia ERMOLAEVA
   6
   7 #ifndef FeaturesPlugin_Partition_H_
   8 #define FeaturesPlugin_Partition_H_
   9
  10 #include "FeaturesPlugin.h"
  11 #include <ModelAPI_Feature.h>
  12
  13 #include <GeomAlgoAPI_Partition.h>
  14
  15 /**\class FeaturesPlugin_Partition
  16  * \ingroup Plugins
  17  * \brief Feature for applying of Partition operations on Solids. Partition makes conjunctional
  18  * faces of solids as shared. The result of partitions is a compsolid.
  19  * Main objects are solids, tool objects are solids or faces
  20  */
  21 class FeaturesPlugin_Partition : public ModelAPI_Feature
  22 {
  23 public:
  24   /// Extrusion kind
  25   inline static const std::string& ID()
  26   {
  27     static const std::string MY_ID("Partition");
  28     return MY_ID;
  29   }
  30   /// attribute name of referenced object
  31   inline static const std::string& OBJECT_LIST_ID()
  32   {
  33     static const std::string MY_OBJECT_LIST_ID("main_objects");
  34     return MY_OBJECT_LIST_ID;
  35   }
  36   /// attribute name of tool object
  37   inline static const std::string& TOOL_LIST_ID()
  38   {
  39     static const std::string MY_TOOL_LIST_ID("tool_objects");
  40     return MY_TOOL_LIST_ID;
  41   }
  42
  43   /// attribute name of combine flag
  44   inline static const std::string& COMBINE_ID()
  45   {
  46     static const std::string MY_COMBINE_ID("partition_combine");
  47     return MY_COMBINE_ID;
  48   }
  49
  50   /// Returns the kind of a feature
  51   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  52   {
  53     static std::string MY_KIND = FeaturesPlugin_Partition::ID();
  54     return MY_KIND;
  55   }
  56
  57   /// Creates a new part document if needed
  58   FEATURESPLUGIN_EXPORT virtual void execute();
  59
  60   /// Request for initialization of data model of the feature: adding all attributes
  61   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  62
  63   /// Use plugin manager for features creation
  64   FeaturesPlugin_Partition();
  65
  66 private:
  67   std::shared_ptr<GeomAPI_Shape> getShape(const std::string& theAttrName);
  68
  69   /// Load Naming data structure of the feature to the document
  70   void loadNamingDS(std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  71                     const std::shared_ptr<GeomAPI_Shape> theBaseShape,
  72                     const ListOfShape& theTools,
  73                     const std::shared_ptr<GeomAPI_Shape> theResultShape,
  74                     GeomAlgoAPI_MakeShape& theMakeShape,
  75                     GeomAPI_DataMapOfShapeShape& theMapOfShapes);
  76
  77 };
  78
  79 #endif