src/GeomAlgoAPI/GeomAlgoAPI_EdgeBuilder.h

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