src/FeaturesPlugin/FeaturesPlugin_ExtrusionCut.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        FeaturesPlugin_ExtrusionCut.h
   4 // Created:     12 May 2015
   5 // Author:      Dmitry Bobylev
   6
   7 #ifndef FeaturesPlugin_ExtrusionCut_H_
   8 #define FeaturesPlugin_ExtrusionCut_H_
   9
  10 #include <FeaturesPlugin.h>
  11
  12 #include <ModelAPI_Feature.h>
  13
  14 /** \class FeaturesPlugin_ExtrusionCut
  15  *  \ingroup Plugins
  16  */
  17 class FeaturesPlugin_ExtrusionCut : public ModelAPI_Feature
  18 {
  19  public:
  20   /// Revolution kind.
  21   inline static const std::string& ID()
  22   {
  23     static const std::string MY_REVOLUTION_ID("ExtrusionCut");
  24     return MY_REVOLUTION_ID;
  25   }
  26
  27   /// attribute name of references sketch entities list, it should contain a sketch result or
  28   /// a pair a sketch result to sketch face
  29   inline static const std::string& LIST_ID()
  30   {
  31     static const std::string MY_GROUP_LIST_ID("main_objects");
  32     return MY_GROUP_LIST_ID;
  33   }
  34
  35   /// attribute name of an object to which the extrusion grows
  36   inline static const std::string& SKETCH_OBJECT_ID()
  37   {
  38     static const std::string MY_TO_OBJECT_ID("sketch");
  39     return MY_TO_OBJECT_ID;
  40   }
  41
  42   /// Attribute name of an object to which the extrusion grows.
  43   inline static const std::string& AXIS_OBJECT_ID()
  44   {
  45     static const std::string MY_TO_OBJECT_ID("axis_object");
  46     return MY_TO_OBJECT_ID;
  47   }
  48
  49   /// attribute name of extrusion size
  50   inline static const std::string& TO_SIZE_ID()
  51   {
  52     static const std::string MY_TO_SIZE_ID("to_size");
  53     return MY_TO_SIZE_ID;
  54   }
  55
  56   /// attribute name of extrusion size
  57   inline static const std::string& FROM_SIZE_ID()
  58   {
  59     static const std::string MY_FROM_SIZE_ID("from_size");
  60     return MY_FROM_SIZE_ID;
  61   }
  62
  63   /// attribute name of an object to which the extrusion grows
  64   inline static const std::string& TO_OBJECT_ID()
  65   {
  66     static const std::string MY_TO_OBJECT_ID("to_object");
  67     return MY_TO_OBJECT_ID;
  68   }
  69
  70   /// attribute name of tool object
  71   inline static const std::string& FROM_OBJECT_ID()
  72   {
  73     static const std::string MY_FROM_OBJECT_ID("from_object");
  74     return MY_FROM_OBJECT_ID;
  75   }
  76
  77   /// Returns the kind of a feature
  78   FEATURESPLUGIN_EXPORT virtual const std::string& getKind()
  79   {
  80     static std::string MY_KIND = FeaturesPlugin_ExtrusionCut::ID();
  81     return MY_KIND;
  82   }
  83
  84   /// Creates a new part document if needed.
  85   FEATURESPLUGIN_EXPORT virtual void execute();
  86
  87   /// Request for initialization of data model of the feature: adding all attributes.
  88   FEATURESPLUGIN_EXPORT virtual void initAttributes();
  89
  90   /// Use plugin manager for features creation.
  91   FeaturesPlugin_ExtrusionCut();
  92 };
  93
  94 #endif