src/SketchPlugin/SketchPlugin_Line.h

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