src/SketchPlugin/SketchPlugin_BSpline.h

   1 // Copyright (C) 2019-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_BSpline_H_
  21 #define SketchPlugin_BSpline_H_
  22
  23 #include <SketchPlugin.h>
  24 #include <SketchPlugin_SketchEntity.h>
  25
  26 /**\class SketchPlugin_BSpline
  27  * \ingroup Plugins
  28  * \brief Feature for creation of the B-spline curve in the sketch.
  29  */
  30 class SketchPlugin_BSpline : public SketchPlugin_SketchEntity
  31 {
  32 public:
  33   /// Ellipse feature kind
  34   inline static const std::string& ID()
  35   {
  36     static const std::string ID("SketchBSpline");
  37     return ID;
  38   }
  39
  40   /// list of B-spline poles
  41   inline static const std::string& POLES_ID()
  42   {
  43     static const std::string ID("poles");
  44     return ID;
  45   }
  46
  47   /// list of B-spline weights
  48   inline static const std::string& WEIGHTS_ID()
  49   {
  50     static const std::string ID("weights");
  51     return ID;
  52   }
  53
  54   /// attribute to store the degree of B-spline
  55   inline static const std::string& DEGREE_ID()
  56   {
  57     static const std::string ID("degree");
  58     return ID;
  59   }
  60
  61   /// Returns the kind of a feature
  62   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
  63   {
  64     static std::string MY_KIND = SketchPlugin_BSpline::ID();
  65     return MY_KIND;
  66   }
  67
  68   /// Returns true is sketch element is under the rigid constraint
  69   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  70
  71   /// Called on change of any argument-attribute of this object
  72   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  73
  74   /// Creates a new part document if needed
  75   SKETCHPLUGIN_EXPORT virtual void execute();
  76
  77   /// Use plugin manager for features creation
  78   SketchPlugin_BSpline();
  79
  80 protected:
  81   /// \brief Initializes attributes of derived class.
  82   virtual void initDerivedClassAttributes();
  83 };
  84
  85 #endif