src/GeomAlgoAPI/GeomAlgoAPI_NormalToFace.h

   1 // Copyright (C) 2014-2021  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_NormalToFace_H_
  21 #define GeomAlgoAPI_NormalToFace_H_
  22
  23 #include <GeomAlgoAPI.h>
  24 #include <GeomAPI_Edge.h>
  25 #include <GeomAPI_Face.h>
  26
  27 /**\class GeomAlgoAPI_NormalToFace
  28  * \ingroup DataAlgo
  29  * \brief Allows to create normal to face-shapes
  30  */
  31
  32 class GeomAlgoAPI_NormalToFace
  33 {
  34  public:
  35   /// Get the normal to face-shapes
  36   /// \param theface   the face
  37   /// \param thePoint the optional point
  38   /// \param theNormal the normal
  39   /// \param theError the error
  40   GEOMALGOAPI_EXPORT  static bool normal(GeomShapePtr theFace,
  41                                          GeomShapePtr thePoint,
  42                                          GeomEdgePtr  theNormal,
  43                                          std::string& theError);
  44 };
  45
  46 #endif