src/GeomAlgoAPI/GeomAlgoAPI_EdgeBuilder.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAlgoAPI_EdgeBuilder.h
   4 // Created:     23 Apr 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef GeomAlgoAPI_EdgeBuilder_H_
   8 #define GeomAlgoAPI_EdgeBuilder_H_
   9
  10 #include <GeomAlgoAPI.h>
  11 #include <GeomAPI_Edge.h>
  12 #include <GeomAPI_Pnt.h>
  13 #include <GeomAPI_Dir.h>
  14 #include <memory>
  15
  16 /**\class GeomAlgoAPI_EdgeBuilder
  17  * \ingroup DataAlgo
  18  * \brief Allows to create face-shapes by different parameters
  19  */
  20
  21 class GEOMALGOAPI_EXPORT GeomAlgoAPI_EdgeBuilder
  22 {
  23  public:
  24   /// Creates linear edge by two points.
  25   /// \param theStart a first point of an edge
  26   /// \param theEnd an end point of an edge
  27   /// \param theInfinite if true, the shape of the edge is infinite. It is used for axis edge.
  28   static std::shared_ptr<GeomAPI_Edge> line(std::shared_ptr<GeomAPI_Pnt> theStart,
  29                                             std::shared_ptr<GeomAPI_Pnt> theEnd,
  30                                             const bool theInfinite = false);
  31   /// Creates edge - axis of the given cylindrical face. The result axis edge is infinite
  32   static std::shared_ptr<GeomAPI_Edge> cylinderAxis(
  33     std::shared_ptr<GeomAPI_Shape> theCylindricalFace);
  34
  35   /// Creates linear edge in a form of a circle by a point and a circle radius
  36   static std::shared_ptr<GeomAPI_Edge> lineCircle(std::shared_ptr<GeomAPI_Pnt> theCenter,
  37                                                     std::shared_ptr<GeomAPI_Dir> theNormal,
  38                                                     double theRadius);
  39
  40   /// Creates linear edge in a form of a circle arc by a three points
  41   static std::shared_ptr<GeomAPI_Edge> lineCircleArc(std::shared_ptr<GeomAPI_Pnt> theCenter,
  42                                                        std::shared_ptr<GeomAPI_Pnt> theStartPoint,
  43                                                        std::shared_ptr<GeomAPI_Pnt> theEndPoint,
  44                                                        std::shared_ptr<GeomAPI_Dir> theNormal);
  45 };
  46
  47 #endif