src/GeomAlgoAPI/GeomAlgoAPI_FaceBuilder.h

   1 // Copyright (C) 2014-2023  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_FaceBuilder_H_
  21 #define GeomAlgoAPI_FaceBuilder_H_
  22
  23 #include "GeomAlgoAPI.h"
  24
  25 #include <memory>
  26
  27 class GeomAPI_Dir;
  28 class GeomAPI_Face;
  29 class GeomAPI_Pln;
  30 class GeomAPI_Pnt;
  31 class GeomAPI_Vertex;
  32
  33 /// \class GeomAlgoAPI_FaceBuilder
  34 /// \ingroup DataAlgo
  35 /// \brief Allows to create face-shapes by different parameters
  36 class GEOMALGOAPI_EXPORT GeomAlgoAPI_FaceBuilder
  37 {
  38  public:
  39   /// Creates square planar face by given point of the center,
  40   /// normal to the plane and size of square
  41   static std::shared_ptr<GeomAPI_Face> squareFace(const std::shared_ptr<GeomAPI_Pnt> theCenter,
  42                                                   const std::shared_ptr<GeomAPI_Dir> theNormal,
  43                                                   const double theSize);
  44   /// Creates square planar face by given point of the center,
  45   /// normal to the plane and size of square
  46   static std::shared_ptr<GeomAPI_Face> squareFace(const std::shared_ptr<GeomAPI_Pln> thePlane,
  47                                                   const double theSize);
  48
  49   /// Creates the planar face by given point of the center and normal to the plane.
  50   static std::shared_ptr<GeomAPI_Face> planarFace(const std::shared_ptr<GeomAPI_Pnt> theCenter,
  51                                                   const std::shared_ptr<GeomAPI_Dir> theNormal);
  52
  53   /// Creates a planar face by given plane, left lower point and size.
  54   static std::shared_ptr<GeomAPI_Face> planarFace(const std::shared_ptr<GeomAPI_Pln> thePlane,
  55                                                   const double theX, const double theY,
  56                                                   const double theWidth, const double theHeight);
  57
  58   /// Creates a planar face by three vertices.
  59   static std::shared_ptr<GeomAPI_Face> planarFaceByThreeVertices(
  60                         const std::shared_ptr<GeomAPI_Vertex> theVertex1,
  61                         const std::shared_ptr<GeomAPI_Vertex> theVertex2,
  62                         const std::shared_ptr<GeomAPI_Vertex> theVertex3);
  63 };
  64
  65 #endif