OCCT

// Created on: 1994-03-21
// Created by: Bruno DUMORTIER
// Copyright (c) 1994-1999 Matra Datavision
// Copyright (c) 1999-2014 OPEN CASCADE SAS
//
// This file is part of Open CASCADE Technology software library.
//
// This library is free software; you can redistribute it and/or modify it under
// the terms of the GNU Lesser General Public License version 2.1 as published
// by the Free Software Foundation, with special exception defined in the file
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
// distribution for complete text of the license and disclaimer of any warranty.
//
// Alternatively, this file may be used under the terms of Open CASCADE
// commercial license or contractual agreement.

#ifndef _GeomAPI_PointsToBSpline_HeaderFile
#define _GeomAPI_PointsToBSpline_HeaderFile

#include <Standard.hxx>
#include <Standard_DefineAlloc.hxx>
#include <Standard_Handle.hxx>

#include <gp_Pnt.hxx>
#include <NCollection_Array1.hxx>
#include <Standard_Integer.hxx>
#include <GeomAbs_Shape.hxx>
#include <Approx_ParametrizationType.hxx>
class Geom_BSplineCurve;

//! This class is used to approximate a BsplineCurve
//! passing through an array of points, with a given Continuity.
//! Describes functions for building a 3D BSpline
//! curve which approximates a set of points.
//! A PointsToBSpline object provides a framework for:
//! -   defining the data of the BSpline curve to be built,
//! -   implementing the approximation algorithm, and consulting the results.
class GeomAPI_PointsToBSpline
{
public:
  DEFINE_STANDARD_ALLOC

  //! Constructs an empty approximation algorithm.
  //! Use an Init function to define and build the BSpline curve.
  Standard_EXPORT GeomAPI_PointsToBSpline();

  //! Approximate a BSpline Curve passing through an
  //! array of Point. The resulting BSpline will have
  //! the following properties:
  //! 1- his degree will be in the range [Degmin,Degmax]
  //! 2- his continuity will be at least <Continuity>
  //! 3- the distance from the point <Points> to the
  //! BSpline will be lower to Tol3D
  Standard_EXPORT GeomAPI_PointsToBSpline(const NCollection_Array1<gp_Pnt>& Points,
                                          const int                         DegMin     = 3,
                                          const int                         DegMax     = 8,
                                          const GeomAbs_Shape               Continuity = GeomAbs_C2,
                                          const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point. The resulting BSpline will have
  //! the following properties:
  //! 1- his degree will be in the range [Degmin,Degmax]
  //! 2- his continuity will be at least <Continuity>
  //! 3- the distance from the point <Points> to the
  //! BSpline will be lower to Tol3D
  Standard_EXPORT GeomAPI_PointsToBSpline(const NCollection_Array1<gp_Pnt>& Points,
                                          const Approx_ParametrizationType  ParType,
                                          const int                         DegMin     = 3,
                                          const int                         DegMax     = 8,
                                          const GeomAbs_Shape               Continuity = GeomAbs_C2,
                                          const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point, which parameters are given by the
  //! array <Parameters>.
  //! The resulting BSpline will have the following
  //! properties:
  //! 1- his degree will be in the range [Degmin,Degmax]
  //! 2- his continuity will be at least <Continuity>
  //! 3- the distance from the point <Points> to the
  //! BSpline will be lower to Tol3D
  Standard_EXPORT GeomAPI_PointsToBSpline(const NCollection_Array1<gp_Pnt>& Points,
                                          const NCollection_Array1<double>& Parameters,
                                          const int                         DegMin     = 3,
                                          const int                         DegMax     = 8,
                                          const GeomAbs_Shape               Continuity = GeomAbs_C2,
                                          const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point using variational smoothing algorithm,
  //! which tries to minimize additional criterium:
  //! Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion
  Standard_EXPORT GeomAPI_PointsToBSpline(const NCollection_Array1<gp_Pnt>& Points,
                                          const double                      Weight1,
                                          const double                      Weight2,
                                          const double                      Weight3,
                                          const int                         DegMax     = 8,
                                          const GeomAbs_Shape               Continuity = GeomAbs_C2,
                                          const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point. The resulting BSpline will have
  //! the following properties:
  //! 1- his degree will be in the range [Degmin,Degmax]
  //! 2- his continuity will be at least <Continuity>
  //! 3- the distance from the point <Points> to the
  //! BSpline will be lower to Tol3D
  Standard_EXPORT void Init(const NCollection_Array1<gp_Pnt>& Points,
                            const int                         DegMin     = 3,
                            const int                         DegMax     = 8,
                            const GeomAbs_Shape               Continuity = GeomAbs_C2,
                            const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point. The resulting BSpline will have
  //! the following properties:
  //! 1- his degree will be in the range [Degmin,Degmax]
  //! 2- his continuity will be at least <Continuity>
  //! 3- the distance from the point <Points> to the
  //! BSpline will be lower to Tol3D
  Standard_EXPORT void Init(const NCollection_Array1<gp_Pnt>& Points,
                            const Approx_ParametrizationType  ParType,
                            const int                         DegMin     = 3,
                            const int                         DegMax     = 8,
                            const GeomAbs_Shape               Continuity = GeomAbs_C2,
                            const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point, which parameters are given by the
  //! array <Parameters>.
  //! The resulting BSpline will have the following
  //! properties:
  //! 1- his degree will be in the range [Degmin,Degmax]
  //! 2- his continuity will be at least <Continuity>
  //! 3- the distance from the point <Points> to the
  //! BSpline will be lower to Tol3D
  Standard_EXPORT void Init(const NCollection_Array1<gp_Pnt>& Points,
                            const NCollection_Array1<double>& Parameters,
                            const int                         DegMin     = 3,
                            const int                         DegMax     = 8,
                            const GeomAbs_Shape               Continuity = GeomAbs_C2,
                            const double                      Tol3D      = 1.0e-3);

  //! Approximate a BSpline Curve passing through an
  //! array of Point using variational smoothing algorithm,
  //! which tries to minimize additional criterium:
  //! Weight1*CurveLength + Weight2*Curvature + Weight3*Torsion
  Standard_EXPORT void Init(const NCollection_Array1<gp_Pnt>& Points,
                            const double                      Weight1,
                            const double                      Weight2,
                            const double                      Weight3,
                            const int                         DegMax     = 8,
                            const GeomAbs_Shape               Continuity = GeomAbs_C2,
                            const double                      Tol3D      = 1.0e-3);

  //! Returns the computed BSpline curve.
  //! Raises StdFail_NotDone if the curve is not built.
  Standard_EXPORT const occ::handle<Geom_BSplineCurve>& Curve() const;
  Standard_EXPORT operator occ::handle<Geom_BSplineCurve>() const;

  Standard_EXPORT bool IsDone() const;

private:
  bool                           myIsDone;
  occ::handle<Geom_BSplineCurve> myCurve;
};

#endif // _GeomAPI_PointsToBSpline_HeaderFile