src/GeomAlgoAPI/GeomAlgoAPI_CurveBuilder.h

   1 // Copyright (C) 2014-2024  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 GeomAlgoAPI_CurveBuilder_H_
  21 #define GeomAlgoAPI_CurveBuilder_H_
  22
  23 #include "GeomAlgoAPI.h"
  24
  25 #include <GeomAPI_Pnt.h>
  26 #include <GeomAPI_Edge.h>
  27
  28 /// \class GeomAlgoAPI_CurveBuilder
  29 /// \ingroup DataAlgo
  30 /// \brief Allows to create a curve by the list of point.
  31 class GeomAlgoAPI_CurveBuilder
  32 {
  33  public:
  34    /// \brief Creates an interpolation curve from points.
  35    /// \param[in] thePoints list of points.
  36    /// \param[in] thePeriodic defines whether the curve to be periodic.
  37    /// \param[in] theIsToReorder defines whether to change the order of points to construct
  38    ///            the shortest curve.
  39    /// \param[in] theStartTangent vector tangent to the start of curve.
  40    /// \param[in] theEndTangent vector tangent to the end of curve.
  41    /// \return Interpolation curve (edge). Empty in case of error or bad input.
  42    GEOMALGOAPI_EXPORT static GeomEdgePtr edge(const std::list<GeomPointPtr>& thePoints,
  43                                               const bool thePeriodic,
  44                                               const bool theIsToReorder,
  45                                               const GeomDirPtr& theStartTangent,
  46                                               const GeomDirPtr& theEndTangent);
  47
  48    /// \brief Approximate the given points by a curve.
  49    /// \param[in] thePoints list of points.
  50    /// \param[in] thePeriodic defines whether the curve to be periodic.
  51    /// \param[in] thePrecision how close the curve should be to the points.
  52    /// \return Apporimation curve (edge). Empty in case of error or bad input.
  53    GEOMALGOAPI_EXPORT static GeomEdgePtr approximate(const std::list<GeomPointPtr>& thePoints,
  54                                                      const bool thePeriodic,
  55                                                      const double thePrecision);
  56
  57    /// \brief Reoder the list of points to get a polyline of minimal length
  58    GEOMALGOAPI_EXPORT static void reorderPoints(std::list<GeomPointPtr>& thePoints);
  59 };
  60
  61 #endif