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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef SketchPlugin_Line_H_
  22 #define SketchPlugin_Line_H_
  23
  24 #include <ModelAPI_IReentrant.h>
  25
  26 #include "SketchPlugin.h"
  27 #include <SketchPlugin_SketchEntity.h>
  28 #include <SketchPlugin_Sketch.h>
  29 #include <list>
  30
  31 class GeomAPI_Pnt2d;
  32
  33 /**\class SketchPlugin_Line
  34  * \ingroup Plugins
  35  * \brief Feature for creation of the new part in PartSet.
  36  */
  37 class SketchPlugin_Line : public SketchPlugin_SketchEntity,
  38                           public ModelAPI_IReentrant
  39 {
  40  public:
  41   /// Arc feature kind
  42   inline static const std::string& ID()
  43   {
  44     static const std::string SKETCH_LINE_ID("SketchLine");
  45     return SKETCH_LINE_ID;
  46   }
  47   /// Start 2D point of the line
  48   inline static const std::string& START_ID()
  49   {
  50     static const std::string MY_START_ID("StartPoint");
  51     return MY_START_ID;
  52   }
  53   /// End 2D point of the line
  54   inline static const std::string& END_ID()
  55   {
  56     static const std::string MY_END_ID("EndPoint");
  57     return MY_END_ID;
  58   }
  59
  60   /// Line length.
  61   static const std::string& LENGTH_ID()
  62   {
  63     static const std::string MY_LENGTH("LineLength");
  64     return MY_LENGTH;
  65   }
  66
  67   /// Returns the kind of a feature
  68   SKETCHPLUGIN_EXPORT virtual const std::string& getKind();
  69
  70   /// Returns true is sketch element is under the rigid constraint
  71   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  72
  73   /// Request for initialization of data model of the feature: adding all attributes
  74   virtual void initAttributes();
  75
  76   /// Creates a new part document if needed
  77   SKETCHPLUGIN_EXPORT virtual void execute();
  78
  79   /// Apply information of the message to current object. It fills start attribute of
  80   /// the currrent feature by last attribute of the message feature, build coincidence
  81   /// if message has selected object
  82   virtual std::string processEvent(const std::shared_ptr<Events_Message>& theMessage);
  83
  84   /// Return the distance between the feature and the point
  85   /// \param thePoint the point
  86   double distanceToPoint(const std::shared_ptr<GeomAPI_Pnt2d>& thePoint);
  87
  88   /// Called on change of any argument-attribute of this object
  89   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  90
  91   /// Use plugin manager for features creation
  92   SketchPlugin_Line();
  93
  94 private:
  95   /// Calculates the lenght of the line and fill the lenght attribute with the value
  96   void updateLenghtValue();
  97
  98 protected:
  99   /// \brief Initializes attributes of derived class.
 100   virtual void initDerivedClassAttributes();
 101 };
 102
 103 #endif