src/SketchPlugin/SketchPlugin_Circle.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_Circle_H_
  22 #define SketchPlugin_Circle_H_
  23
  24 #include "SketchPlugin.h"
  25 #include <SketchPlugin_SketchEntity.h>
  26 #include <SketchPlugin_Sketch.h>
  27
  28 /**\class SketchPlugin_Circle
  29  * \ingroup Plugins
  30  * \brief Feature for creation of the new circle in Sketch.
  31  */
  32 class SketchPlugin_Circle: public SketchPlugin_SketchEntity
  33 {
  34  public:
  35   /// Circle feature kind
  36   inline static const std::string& ID()
  37   {
  38     static const std::string ID("SketchCircle");
  39     return ID;
  40   }
  41
  42   /// 2D point - center of the circle
  43   inline static const std::string& CENTER_ID()
  44   {
  45     static const std::string ID("circle_center");
  46     return ID;
  47   }
  48
  49   /// Radius of the circle
  50   inline static const std::string& RADIUS_ID()
  51   {
  52     static const std::string ID("circle_radius");
  53     return ID;
  54   }
  55
  56   /// Returns the kind of a feature
  57   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  58   {
  59     static std::string MY_KIND = SketchPlugin_Circle::ID();
  60     return MY_KIND;
  61   }
  62
  63   /// Returns true is sketch element is under the rigid constraint
  64   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  65
  66   /// Called on change of any argument-attribute of this object
  67   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  68
  69   /// Creates a new part document if needed
  70   SKETCHPLUGIN_EXPORT virtual void execute();
  71
  72   /// Moves the feature
  73   /// \param theDeltaX the delta for X coordinate is moved
  74   /// \param theDeltaY the delta for Y coordinate is moved
  75   SKETCHPLUGIN_EXPORT virtual void move(const double theDeltaX, const double theDeltaY);
  76
  77   /// Use plugin manager for features creation
  78   SketchPlugin_Circle();
  79
  80 protected:
  81   /// \brief Initializes attributes of derived class.
  82   virtual void initDerivedClassAttributes();
  83 };
  84
  85 #endif