src/SketchPlugin/SketchPlugin_Circle.h

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