src/FeaturesPlugin/FeaturesPlugin_Extrusion.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 // File:        FeaturesPlugin_Extrusion.h
   4 // Created:     30 May 2014
   5 // Author:      Vitaly SMETANNIKOV
   6
   7 #ifndef FeaturesPlugin_Extrusion_H_
   8 #define FeaturesPlugin_Extrusion_H_
   9
  10 #include <FeaturesPlugin.h>
  11 #include <ModelAPI_Feature.h>
  12 #include <GeomAlgoAPI_Prism.h>
  13
  14 class GeomAPI_Shape;
  15 class ModelAPI_ResultBody;
  16
  17 /**\class FeaturesPlugin_Extrusion
  18  * \ingroup Plugins
  19  * \brief Feature for creation of extrusion from the planar face.
  20  *
  21  * Extrusion creates the lateral faces based on edges of the base face and
  22  * the top and bottom faces equal to the base face or this faces can be projection on the
  23  * bounding planes if they were set. Direction of extrusion is taken from the face
  24  * plane or if the bounding faces were set then it will be from the bottom to the top plane.
  25  */
  26 class FeaturesPlugin_Extrusion : public ModelAPI_Feature
  27 {
  28  public:
  29   /// Extrusion kind
  30   inline static const std::string& ID()
  31   {
  32     static const std::string MY_EXTRUSION_ID("Extrusion");
  33     return MY_EXTRUSION_ID;
  34   }
  35   /// attribute name of references sketch entities list, it should contain a sketch result or
  36   /// a pair a sketch result to sketch face
  37   inline static const std::string& LIST_ID()
  38   {
  39     static const std::string MY_GROUP_LIST_ID("base");
  40     return MY_GROUP_LIST_ID;
  41   }
  42
  43   /// attribute name of an object to which the extrusion grows
  44   inline static const std::string& AXIS_OBJECT_ID()
  45   {
  46     static const std::string MY_TO_OBJECT_ID("axis_object");
  47     return MY_TO_OBJECT_ID;
  48   }
  49
  50   /// attribute name of extrusion size
  51   inline static const std::string& TO_SIZE_ID()
  52   {
  53     static const std::string MY_TO_SIZE_ID("to_size");
  54     return MY_TO_SIZE_ID;
  55   }
  56
  57   /// attribute name of extrusion size
  58   inline static const std::string& FROM_SIZE_ID()
  59   {
  60     static const std::string MY_FROM_SIZE_ID("from_size");
  61     return MY_FROM_SIZE_ID;
  62   }
  63
  64   /// attribute name of an object to which the extrusion grows
  65   inline static const std::string& TO_OBJECT_ID()
  66   {
  67     static const std::string MY_TO_OBJECT_ID("to_object");
  68     return MY_TO_OBJECT_ID;
  69   }
  70
  71   /// attribute name of tool object
  72   inline static const std::string& FROM_OBJECT_ID()
  73   {
  74     static const std::string MY_FROM_OBJECT_ID("from_object");
  75     return MY_FROM_OBJECT_ID;
  76   }
  77
  78   /// Returns the kind of a feature
  79   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  80   {
  81     static std::string MY_KIND = FeaturesPlugin_Extrusion::ID();
  82     return MY_KIND;
  83   }
  84
  85   /// Creates a new part document if needed
  86   FEATURESPLUGIN_EXPORT virtual void execute();
  87
  88   /// Request for initialization of data model of the feature: adding all attributes
  89   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  90
  91   /// Use plugin manager for features creation
  92   FeaturesPlugin_Extrusion();
  93 private:
  94   /// Load Naming data structure of the feature to the document
  95   void LoadNamingDS(GeomAlgoAPI_Prism& theFeature, std::shared_ptr<ModelAPI_ResultBody> theResultBody,
  96                     std::shared_ptr<GeomAPI_Shape> theBasis,
  97                     std::shared_ptr<GeomAPI_Shape> theContext);
  98 };
  99
 100 #endif