src/GeomAPI/GeomAPI_BSpline.h

   1 // Copyright (C) 2019-2023  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 GeomAPI_BSpline_H_
  21 #define GeomAPI_BSpline_H_
  22
  23 #include <GeomAPI_Interface.h>
  24 #include <GeomAPI_Curve.h>
  25
  26 #include <list>
  27 #include <memory>
  28
  29 class GeomAPI_Pnt;
  30 class GeomAPI_BSpline;
  31
  32 //! Pointer on the object
  33 typedef std::shared_ptr<GeomAPI_BSpline> GeomBSplinePtr;
  34
  35 /**\class GeomAPI_BSpline
  36  * \ingroup DataModel
  37  * \brief B-spline in 3D
  38  */
  39 class GeomAPI_BSpline : public GeomAPI_Interface
  40 {
  41 public:
  42   /// Creation of B-spline defined by a curve
  43   GEOMAPI_EXPORT GeomAPI_BSpline (const GeomCurvePtr& theCurve);
  44
  45   /// Degree of B-spline curve
  46   GEOMAPI_EXPORT int degree() const;
  47
  48   /// Poles of B-spline curve
  49   GEOMAPI_EXPORT std::list<std::shared_ptr<GeomAPI_Pnt> > poles() const;
  50
  51   /// Weights of B-spline poles
  52   GEOMAPI_EXPORT std::list<double> weights() const;
  53
  54   /// Knots of B-spline curve
  55   GEOMAPI_EXPORT std::list<double> knots() const;
  56
  57   /// Multiplicities of B-spline knots
  58   GEOMAPI_EXPORT std::list<int> mults() const;
  59
  60   /// Return \c true if the curve is periodic
  61   GEOMAPI_EXPORT bool isPeriodic() const;
  62
  63   /// Convert any curve into a B-spline curve
  64   GEOMAPI_EXPORT static GeomBSplinePtr convertToBSpline (const GeomCurvePtr& theCurve);
  65 };
  66
  67 #endif