src/SketchPlugin/SketchPlugin_Rectangle.h

   1 // Copyright (C) 2014-2020  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
  18 //
  19
  20 #ifndef SketchPlugin_Rectangle_H_
  21 #define SketchPlugin_Rectangle_H_
  22
  23 #include "SketchPlugin.h"
  24 #include "SketchPlugin_SketchEntity.h"
  25
  26 /**\class SketchPlugin_Rectangle
  27  * \ingroup Plugins
  28  * \brief Feature for creation of the new Rectangle in Sketch.
  29  */
  30 class SketchPlugin_Rectangle: public SketchPlugin_SketchEntity
  31 {
  32  public:
  33   /// Rectangle feature kind
  34   inline static const std::string& ID()
  35   {
  36     static const std::string ID("SketchRectangle");
  37     return ID;
  38   }
  39
  40   /// 2D point - start point of the Rectangle
  41   inline static const std::string& START_ID()
  42   {
  43     static const std::string ID("rectangle_start_point");
  44     return ID;
  45   }
  46
  47   /// 2D point - end point of the Rectangle
  48   inline static const std::string& END_ID()
  49   {
  50     static const std::string ID("rectangle_end_point");
  51     return ID;
  52   }
  53
  54   /// 2D point - center point of the Rectangle
  55   inline static const std::string& CENTER_ID()
  56   {
  57     static const std::string ID("rectangle_center_point");
  58     return ID;
  59   }
  60
  61   /// 2D point - center point of the Rectangle
  62   inline static const std::string& CENTER_REF_ID()
  63   {
  64     static const std::string ID("rectangle_center_point_ref");
  65     return ID;
  66   }
  67
  68   /// 2D point - list of Rectangle lines
  69   inline static const std::string& LINES_LIST_ID()
  70   {
  71     static const std::string ID("RectangleLinesList");
  72     return ID;
  73   }
  74
  75   /// 2D point - list of Diagonal lines
  76   inline static const std::string& DIAGONAL_LIST_ID()
  77   {
  78     static const std::string ID("RectangleDiagonalLinesList");
  79     return ID;
  80   }
  81
  82   inline static const std::string& ISHV_LIST_ID()
  83   {
  84     static const std::string ID("IsHVList");
  85     return ID;
  86   }
  87
  88   inline static const std::string& NOT_TO_DUMP_LIST_ID()
  89   {
  90     static const std::string ID("NotToDumpList");
  91     return ID;
  92   }
  93
  94   /// Returns the kind of a feature
  95   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  96   {
  97     static std::string MY_KIND = SketchPlugin_Rectangle::ID();
  98     return MY_KIND;
  99   }
 100
 101   SKETCHPLUGIN_EXPORT virtual bool isMacro() const
 102   { return true;}
 103
 104   /// Called on change of any argument-attribute of this object
 105   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
 106
 107   /// Creates a new part document if needed
 108   SKETCHPLUGIN_EXPORT virtual void execute();
 109
 110   /// Use plugin manager for features creation
 111   SketchPlugin_Rectangle();
 112
 113 protected:
 114   /// \brief Initializes attributes of derived class.
 115   virtual void initDerivedClassAttributes();
 116
 117 private:
 118   /// \brief updateLines crates lines from start and en points
 119   void updateLines();
 120   void updateStartPoint();
 121 };
 122
 123
 124 #endif