src/GeomAlgoAPI/GeomAlgoAPI_EdgeBuilder.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_EdgeBuilder_H_
  22 #define GeomAlgoAPI_EdgeBuilder_H_
  23
  24 #include <GeomAlgoAPI.h>
  25 #include <GeomAPI_Edge.h>
  26 #include <GeomAPI_Pnt.h>
  27 #include <GeomAPI_Dir.h>
  28 #include <GeomAPI_Lin.h>
  29 #include <GeomAPI_Circ.h>
  30 #include <memory>
  31
  32 /**\class GeomAlgoAPI_EdgeBuilder
  33  * \ingroup DataAlgo
  34  * \brief Allows to create face-shapes by different parameters
  35  */
  36
  37 class GEOMALGOAPI_EXPORT GeomAlgoAPI_EdgeBuilder
  38 {
  39  public:
  40   /// Creates linear edge by two points.
  41   /// \param theStart a first point of an edge
  42   /// \param theEnd an end point of an edge
  43   static std::shared_ptr<GeomAPI_Edge> line(std::shared_ptr<GeomAPI_Pnt> theStart,
  44                                             std::shared_ptr<GeomAPI_Pnt> theEnd);
  45
  46   /// Creates linear edge by three dimensions.
  47   /// \param theX the X dimension
  48   /// \param theY the Y dimension
  49   /// \param theZ the Z dimension
  50   static std::shared_ptr<GeomAPI_Edge> line(double theDX,
  51                                             double theDY,
  52                                             double theDZ);
  53
  54   /// Creates linear edge by GeomAPI_Lin.
  55   /// \param theLin line.
  56   static std::shared_ptr<GeomAPI_Edge> line(const std::shared_ptr<GeomAPI_Lin> theLin);
  57
  58   /// Creates edge - axis of the given cylindrical face. The result axis edge is infinite
  59   static std::shared_ptr<GeomAPI_Edge> cylinderAxis(
  60     std::shared_ptr<GeomAPI_Shape> theCylindricalFace);
  61
  62   /// Creates linear edge in a form of a circle by a point and a circle radius
  63   static std::shared_ptr<GeomAPI_Edge> lineCircle(std::shared_ptr<GeomAPI_Pnt> theCenter,
  64                                                     std::shared_ptr<GeomAPI_Dir> theNormal,
  65                                                     double theRadius);
  66
  67   /// Creates linear edge in a form of a circle by GeomAPI_Circle
  68   static std::shared_ptr<GeomAPI_Edge> lineCircle(std::shared_ptr<GeomAPI_Circ> theCircle);
  69
  70   /// Creates linear edge in a form of a circle arc by a three points
  71   static std::shared_ptr<GeomAPI_Edge> lineCircleArc(std::shared_ptr<GeomAPI_Pnt> theCenter,
  72                                                        std::shared_ptr<GeomAPI_Pnt> theStartPoint,
  73                                                        std::shared_ptr<GeomAPI_Pnt> theEndPoint,
  74                                                        std::shared_ptr<GeomAPI_Dir> theNormal);
  75 };
  76
  77 #endif