src/GeomAlgoAPI/GeomAlgoAPI_Projection.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 GeomAlgoAPI_Projection_H_
  21 #define GeomAlgoAPI_Projection_H_
  22
  23 #include <GeomAlgoAPI.h>
  24
  25 #include <GeomAPI_Pln.h>
  26
  27 #include <memory>
  28
  29 class GeomAPI_Curve;
  30 class GeomAPI_Edge;
  31
  32 /**\class GeomAlgoAPI_Projection
  33  * \ingroup DataAlgo
  34  * \brief Project curve onto a plane
  35  */
  36 class GeomAlgoAPI_Projection
  37 {
  38 public:
  39   GEOMALGOAPI_EXPORT GeomAlgoAPI_Projection(const std::shared_ptr<GeomAPI_Pln>& thePlane);
  40
  41   /// Project curve to the plane
  42   GEOMALGOAPI_EXPORT
  43   std::shared_ptr<GeomAPI_Curve> project(const std::shared_ptr<GeomAPI_Curve>& theCurve);
  44   /// Project edge to the plane
  45   GEOMALGOAPI_EXPORT
  46   std::shared_ptr<GeomAPI_Curve> project(const std::shared_ptr<GeomAPI_Edge>& theEdge);
  47
  48 private:
  49   std::shared_ptr<GeomAPI_Pln> myPlane;
  50 };
  51
  52 #endif