src/GeomAlgoAPI/GeomAlgoAPI_CurveBuilder.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef GeomAlgoAPI_CurveBuilder_H_
  22 #define GeomAlgoAPI_CurveBuilder_H_
  23
  24 #include "GeomAlgoAPI.h"
  25
  26 #include <GeomAPI_Pnt.h>
  27 #include <GeomAPI_Edge.h>
  28
  29 /// \class GeomAlgoAPI_CurveBuilder
  30 /// \ingroup DataAlgo
  31 /// \brief Allows to create interpolation curve.
  32 class GeomAlgoAPI_CurveBuilder
  33 {
  34  public:
  35    /// \brief Creates an interpolation curve from points.
  36    /// \param[in] thePoints list of points.
  37    /// \param[in] theIsClosed defines whether the curve to be closed.
  38    /// \param[in] theIsToReorder defines whether to change the order of points to construct
  39    ///            the shortest curve.
  40    /// \param[in] theStartTangent vector tangent to the start of curve.
  41    /// \param[in] theEndTangent vector tangent to the end of curve.
  42    /// \return Interpolation curve (edge). Empty in case of error or bad input.
  43    GEOMALGOAPI_EXPORT static GeomEdgePtr edge(const std::list<GeomPointPtr>& thePoints,
  44                                               const bool theIsClosed,
  45                                               const bool theIsToReorder,
  46                                               const GeomDirPtr& theStartTangent,
  47                                               const GeomDirPtr& theEndTangent);
  48 };
  49
  50 #endif