src/SketchPlugin/SketchPlugin_BSplineBase.h

   1 // Copyright (C) 2019-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_BSplineBase_H_
  21 #define SketchPlugin_BSplineBase_H_
  22
  23 #include <SketchPlugin.h>
  24 #include <SketchPlugin_SketchEntity.h>
  25
  26 /**\class SketchPlugin_BSplineBase
  27  * \ingroup Plugins
  28  * \brief Base class for B-spline curves in the sketch.
  29  */
  30 class SketchPlugin_BSplineBase : public SketchPlugin_SketchEntity
  31 {
  32 public:
  33   /// list of B-spline poles
  34   inline static const std::string& POLES_ID()
  35   {
  36     static const std::string ID("poles");
  37     return ID;
  38   }
  39
  40   /// list of B-spline weights
  41   inline static const std::string& WEIGHTS_ID()
  42   {
  43     static const std::string ID("weights");
  44     return ID;
  45   }
  46
  47   /// attribute to store the degree of B-spline
  48   inline static const std::string& DEGREE_ID()
  49   {
  50     static const std::string ID("degree");
  51     return ID;
  52   }
  53
  54   /// list of B-spline knots
  55   inline static const std::string& KNOTS_ID()
  56   {
  57     static const std::string ID("knots");
  58     return ID;
  59   }
  60
  61   /// list of B-spline multiplicities
  62   inline static const std::string& MULTS_ID()
  63   {
  64     static const std::string ID("multiplicities");
  65     return ID;
  66   }
  67
  68   /// name for add pole action
  69   inline static const std::string& ADD_POLE_ACTION_ID()
  70   {
  71     static const std::string ID("AddPole");
  72     return ID;
  73   }
  74
  75   /// Returns true is sketch element is under the rigid constraint
  76   SKETCHPLUGIN_EXPORT virtual bool isFixed();
  77
  78   /// Called on change of any argument-attribute of this object
  79   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
  80
  81   /// Creates a new part document if needed
  82   SKETCHPLUGIN_EXPORT virtual void execute();
  83
  84   /// Updates the B-spline curve.
  85   /// \param[in] theActionId action key id (in following form: Action#Index)
  86   /// \return \c false in case the action not performed.
  87   SKETCHPLUGIN_EXPORT virtual bool customAction(const std::string& theActionId);
  88
  89 protected:
  90   /// Called from the derived class
  91   SketchPlugin_BSplineBase();
  92
  93   /// \brief Initializes attributes of derived class.
  94   virtual void initDerivedClassAttributes();
  95
  96   /// \brief Return \c true if the B-spline curve is periodic
  97   virtual bool isPeriodic() const = 0;
  98
  99   /// Add new pole after the pole with the given index
 100   bool addPole(const int theAfter);
 101 };
 102
 103 #endif