src/ConstructionPlugin/ConstructionPlugin_Point.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ConstructionPlugin_Point.h
   4 // Created:     3 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ConstructionPlugin_Point_H_
   8 #define ConstructionPlugin_Point_H_
   9
  10 #include "ConstructionPlugin.h"
  11 #include <ModelAPI_Feature.h>
  12 #include <ModelAPI_Result.h>
  13
  14 /**\class ConstructionPlugin_Point
  15  * \ingroup Plugins
  16  * \brief Feature for creation of the new part in PartSet.
  17  */
  18 class ConstructionPlugin_Point : public ModelAPI_Feature
  19 {
  20  public:
  21   /// Returns the kind of a feature
  22   CONSTRUCTIONPLUGIN_EXPORT virtual const std::string& getKind();
  23
  24   inline static const std::string& ID()
  25   {
  26     static const std::string CONSTRUCTION_POINT_KIND("Point");
  27     return CONSTRUCTION_POINT_KIND;
  28   }
  29
  30   /// attribute name for X coordinate
  31   inline static const std::string& X()
  32   {
  33     static const std::string POINT_ATTR_X("x");
  34     return POINT_ATTR_X;
  35   }
  36   /// attribute name for Y coordinate
  37   inline static const std::string& Y()
  38   {
  39     static const std::string POINT_ATTR_Y("y");
  40     return POINT_ATTR_Y;
  41   }
  42   /// attribute name for Z coordinate
  43   inline static const std::string& Z()
  44   {
  45     static const std::string POINT_ATTR_Z("z");
  46     return POINT_ATTR_Z;
  47   }
  48
  49   /// Creates a new part document if needed
  50   CONSTRUCTIONPLUGIN_EXPORT virtual void execute();
  51
  52   /// Request for initialization of data model of the feature: adding all attributes
  53   CONSTRUCTIONPLUGIN_EXPORT virtual void initAttributes();
  54
  55   /// Construction result is allways recomuted on the fly
  56   CONSTRUCTIONPLUGIN_EXPORT virtual bool isPersistentResult() {return false;}
  57
  58   /// Use plugin manager for features creation
  59   ConstructionPlugin_Point();
  60 };
  61
  62 #endif