src/SketchPlugin/SketchPlugin_Line.h

   1 // File:        SketchPlugin_Line.h
   2 // Created:     24 Apr 2014
   3 // Author:      Mikhail PONIKAROV
   4
   5 #ifndef SketchPlugin_Line_HeaderFile
   6 #define SketchPlugin_Line_HeaderFile
   7
   8 #include "SketchPlugin.h"
   9 #include <SketchPlugin_Feature.h>
  10 #include <SketchPlugin_Sketch.h>
  11 #include <list>
  12
  13 /**\class SketchPlugin_Line
  14  * \ingroup DataModel
  15  * \brief Feature for creation of the new part in PartSet.
  16  */
  17 class SketchPlugin_Line: public SketchPlugin_Feature
  18 {
  19 public:
  20   /// Arc feature kind
  21   inline static const std::string& ID()
  22   {
  23     static const std::string SKETCH_LINE_ID("SketchLine");
  24     return SKETCH_LINE_ID;
  25   }
  26   /// Start 2D point of the line
  27   inline static const std::string& START_ID()
  28   {
  29     static const std::string MY_START_ID("StartPoint");
  30     return MY_START_ID;
  31   }
  32     /// End 2D point of the line
  33   inline static const std::string& END_ID()
  34   {
  35     static const std::string MY_END_ID("EndPoint");
  36     return MY_END_ID;
  37   }
  38
  39   /// Returns the kind of a feature
  40   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  41   {static std::string MY_KIND = SketchPlugin_Line::ID(); return MY_KIND;}
  42
  43   /// Returns to which group in the document must be added feature
  44   SKETCHPLUGIN_EXPORT virtual const std::string& getGroup()
  45   {static std::string MY_GROUP = SketchPlugin_Sketch::ID(); return MY_GROUP;}
  46
  47   /// Creates a new part document if needed
  48   SKETCHPLUGIN_EXPORT virtual void execute();
  49
  50   /// Request for initialization of data model of the feature: adding all attributes
  51   SKETCHPLUGIN_EXPORT virtual void initAttributes();
  52
  53   /// Returns the sketch preview
  54   SKETCHPLUGIN_EXPORT virtual const boost::shared_ptr<GeomAPI_Shape>& preview();
  55
  56   /// Returns the AIS preview
  57   SKETCHPLUGIN_EXPORT virtual boost::shared_ptr<GeomAPI_AISObject> getAISObject(
  58                                 boost::shared_ptr<GeomAPI_AISObject> thePrevious);
  59
  60   /// Adds sub-feature of the higher level feature (sub-element of the sketch)
  61   /// \param theFeature sub-feature
  62   SKETCHPLUGIN_EXPORT virtual const void addSub(
  63     const FeaturePtr& theFeature) {};
  64
  65   /// Moves the feature
  66   /// \param theDeltaX the delta for X coordinate is moved
  67   /// \param theDeltaY the delta for Y coordinate is moved
  68   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  69
  70   /// Return the distance between the feature and the point
  71   /// \param thePoint the point
  72   virtual double distanceToPoint(const boost::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  73
  74   /// Use plugin manager for features creation
  75   SketchPlugin_Line();
  76 };
  77
  78 #endif