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 #include "SketchPlugin_Sketch.h"
  26
  27 /**\class SketchPlugin_Rectangle
  28  * \ingroup Plugins
  29  * \brief Feature for creation of the new Rectangle in Sketch.
  30  */
  31 class SketchPlugin_Rectangle: public SketchPlugin_SketchEntity
  32
  33 {
  34  public:
  35   /// Rectangle feature kind
  36   inline static const std::string& ID()
  37   {
  38     static const std::string ID("SketchRectangle");
  39     return ID;
  40   }
  41
  42   /// 2D point - start point of the Rectangle
  43   inline static const std::string& START_ID()
  44   {
  45     static const std::string ID("rectangle_start_point");
  46     return ID;
  47   }
  48
  49   /// 2D point - end point of the Rectangle
  50   inline static const std::string& END_ID()
  51   {
  52     static const std::string ID("rectangle_end_point");
  53     return ID;
  54   }
  55
  56   /// 2D point - list of Rectangle lines
  57   inline static const std::string& LINES_LIST_ID()
  58   {
  59     static const std::string ID("RectangleList");
  60     return ID;
  61   }
  62
  63   inline static const std::string& ISHV_LIST_ID()
  64   {
  65     static const std::string ID("IsHVList");
  66     return ID;
  67   }
  68
  69   inline static const std::string& NOT_TO_DUMP_LIST_ID()
  70   {
  71     static const std::string ID("NotToDumpList");
  72     return ID;
  73   }
  74
  75   /// Returns the kind of a feature
  76   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  77   {
  78     static std::string MY_KIND = SketchPlugin_Rectangle::ID();
  79     return MY_KIND;
  80   }
  81
  82   /// Returns true is sketch element is under the rigid constraint
  83   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  84
  85   /// Called on change of any argument-attribute of this object
  86   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  87
  88   /// Creates a new part document if needed
  89   SKETCHPLUGIN_EXPORT virtual void execute();
  90
  91   /// Use plugin manager for features creation
  92   SketchPlugin_Rectangle();
  93
  94 protected:
  95   /// \brief Initializes attributes of derived class.
  96   virtual void initDerivedClassAttributes();
  97
  98 private:
  99   /// \brief updateLines crates lines from start and en points
 100   void updateLines();
 101 };
 102
 103 #endif