src/SketchPlugin/SketchPlugin_Line.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef SketchPlugin_Line_H_
  21 #define SketchPlugin_Line_H_
  22
  23 #include <ModelAPI_IReentrant.h>
  24
  25 #include "SketchPlugin.h"
  26 #include <SketchPlugin_SketchEntity.h>
  27 #include <SketchPlugin_Sketch.h>
  28 #include <list>
  29
  30 class GeomAPI_Pnt2d;
  31
  32 /**\class SketchPlugin_Line
  33  * \ingroup Plugins
  34  * \brief Feature for creation of the new part in PartSet.
  35  */
  36 class SketchPlugin_Line : public SketchPlugin_SketchEntity,
  37                           public ModelAPI_IReentrant
  38 {
  39  public:
  40   /// Arc feature kind
  41   inline static const std::string& ID()
  42   {
  43     static const std::string SKETCH_LINE_ID("SketchLine");
  44     return SKETCH_LINE_ID;
  45   }
  46   /// Start 2D point of the line
  47   inline static const std::string& START_ID()
  48   {
  49     static const std::string MY_START_ID("StartPoint");
  50     return MY_START_ID;
  51   }
  52   /// End 2D point of the line
  53   inline static const std::string& END_ID()
  54   {
  55     static const std::string MY_END_ID("EndPoint");
  56     return MY_END_ID;
  57   }
  58
  59   /// Line length.
  60   static const std::string& LENGTH_ID()
  61   {
  62     static const std::string MY_LENGTH("LineLength");
  63     return MY_LENGTH;
  64   }
  65
  66   /// Returns the kind of a feature
  67   SKETCHPLUGIN_EXPORT virtual const std::string& getKind();
  68
  69   /// Returns true is sketch element is under the rigid constraint
  70   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  71
  72   /// Request for initialization of data model of the feature: adding all attributes
  73   virtual void initAttributes();
  74
  75   /// Creates a new part document if needed
  76   SKETCHPLUGIN_EXPORT virtual void execute();
  77
  78   /// Moves the feature
  79   /// \param theDeltaX the delta for X coordinate is moved
  80   /// \param theDeltaY the delta for Y coordinate is moved
  81   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  82
  83   /// Apply information of the message to current object. It fills start attribute of
  84   /// the currrent feature by last attribute of the message feature, build coincidence
  85   /// if message has selected object
  86   virtual std::string processEvent(const std::shared_ptr<Events_Message>& theMessage);
  87
  88   /// Return the distance between the feature and the point
  89   /// \param thePoint the point
  90   double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  91
  92   /// Called on change of any argument-attribute of this object
  93   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  94
  95   /// Use plugin manager for features creation
  96   SketchPlugin_Line();
  97
  98 private:
  99   /// Calculates the lenght of the line and fill the lenght attribute with the value
 100   void updateLenghtValue();
 101
 102 protected:
 103   /// \brief Initializes attributes of derived class.
 104   virtual void initDerivedClassAttributes();
 105 };
 106
 107 #endif