Salome HOME
Task #3230: Sketcher: create a curve passing through selected points or vertices...
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_CurveBuilder.h
index e35073b8d890c379d379fccfb0a584b4922ab915..57eaf311b2f9c1e38e556578c5fad84e0314358b 100644 (file)
 
 /// \class GeomAlgoAPI_CurveBuilder
 /// \ingroup DataAlgo
-/// \brief Allows to create interpolation curve.
+/// \brief Allows to create a curve by the list of point.
 class GeomAlgoAPI_CurveBuilder
 {
  public:
    /// \brief Creates an interpolation curve from points.
    /// \param[in] thePoints list of points.
-   /// \param[in] theIsClosed defines whether the curve to be closed.
+   /// \param[in] thePeriodic defines whether the curve to be periodic.
    /// \param[in] theIsToReorder defines whether to change the order of points to construct
    ///            the shortest curve.
    /// \param[in] theStartTangent vector tangent to the start of curve.
    /// \param[in] theEndTangent vector tangent to the end of curve.
    /// \return Interpolation curve (edge). Empty in case of error or bad input.
    GEOMALGOAPI_EXPORT static GeomEdgePtr edge(const std::list<GeomPointPtr>& thePoints,
-                                              const bool theIsClosed,
+                                              const bool thePeriodic,
                                               const bool theIsToReorder,
                                               const GeomDirPtr& theStartTangent,
                                               const GeomDirPtr& theEndTangent);
+
+   /// \brief Approximate the given points by a curve.
+   /// \param[in] thePoints list of points.
+   /// \param[in] thePeriodic defines whether the curve to be periodic.
+   /// \param[in] thePrecision how close the curve should be to the points.
+   /// \return Apporimation curve (edge). Empty in case of error or bad input.
+   GEOMALGOAPI_EXPORT static GeomEdgePtr approximate(const std::list<GeomPointPtr>& thePoints,
+                                                     const bool thePeriodic,
+                                                     const double thePrecision);
+
+   /// \brief Reoder the list of points to get a polyline of minimal length
+   GEOMALGOAPI_EXPORT static void reorderPoints(std::list<GeomPointPtr>& thePoints);
 };
 
 #endif