Salome HOME
updated copyright message
[modules/shaper.git] / src / SketchPlugin / SketchPlugin_BSpline.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_BSpline_H_
21 #define SketchPlugin_BSpline_H_
22
23 #include <SketchPlugin_BSplineBase.h>
24
25 /**\class SketchPlugin_BSpline
26  * \ingroup Plugins
27  * \brief Feature for creation of the B-spline curve in the sketch.
28  */
29 class SketchPlugin_BSpline : public SketchPlugin_BSplineBase
30 {
31 public:
32   /// B-spline feature kind
33   inline static const std::string& ID()
34   {
35     static const std::string ID("SketchBSpline");
36     return ID;
37   }
38
39   /// start point of B-spline curve
40   inline static const std::string& START_ID()
41   {
42     static const std::string ID("start_point");
43     return ID;
44   }
45   /// end point of B-spline curve
46   inline static const std::string& END_ID()
47   {
48     static const std::string ID("end_point");
49     return ID;
50   }
51
52   /// Returns the kind of a feature
53   SKETCHPLUGIN_EXPORT virtual const std::string& getKind()
54   {
55     static std::string MY_KIND = SketchPlugin_BSpline::ID();
56     return MY_KIND;
57   }
58
59   /// Called on change of any argument-attribute of this object
60   SKETCHPLUGIN_EXPORT virtual void attributeChanged(const std::string& theID);
61
62   /// Use plugin manager for features creation
63   SketchPlugin_BSpline();
64
65 protected:
66   /// \brief Initializes attributes of derived class.
67   virtual void initDerivedClassAttributes();
68
69   virtual bool isPeriodic() const { return false; }
70 };
71
72 #endif