Salome HOME
Minor corrections: coding rules
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_EdgeBuilder.h
index cd505a8614d57f110f42a634098663eac38e577c..a781ce219ac8ca76356f73c5ad29611fa0a4ad62 100644 (file)
@@ -1,14 +1,19 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        GeomAlgoAPI_EdgeBuilder.h
 // Created:     23 Apr 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef GeomAlgoAPI_EdgeBuilder_HeaderFile
-#define GeomAlgoAPI_EdgeBuilder_HeaderFile
+#ifndef GeomAlgoAPI_EdgeBuilder_H_
+#define GeomAlgoAPI_EdgeBuilder_H_
 
 #include <GeomAlgoAPI.h>
-#include <GeomAPI_Shape.h>
+#include <GeomAPI_Edge.h>
 #include <GeomAPI_Pnt.h>
-#include <boost/shared_ptr.hpp>
+#include <GeomAPI_Dir.h>
+#include <GeomAPI_Lin.h>
+#include <GeomAPI_Circ.h>
+#include <memory>
 
 /**\class GeomAlgoAPI_EdgeBuilder
  * \ingroup DataAlgo
 
 class GEOMALGOAPI_EXPORT GeomAlgoAPI_EdgeBuilder
 {
-public:
-  /// Creates linear edge by two points
-  static boost::shared_ptr<GeomAPI_Shape> line(
-    boost::shared_ptr<GeomAPI_Pnt> theStart, boost::shared_ptr<GeomAPI_Pnt> theEnd);
+ public:
+  /// Creates linear edge by two points.
+  /// \param theStart a first point of an edge
+  /// \param theEnd an end point of an edge
+  static std::shared_ptr<GeomAPI_Edge> line(std::shared_ptr<GeomAPI_Pnt> theStart,
+                                            std::shared_ptr<GeomAPI_Pnt> theEnd);
+
+  /// Creates linear edge by three dimensions.
+  /// \param theX the X dimension
+  /// \param theY the Y dimension
+  /// \param theZ the Z dimension
+  static std::shared_ptr<GeomAPI_Edge> line(double theDX,
+                                            double theDY,
+                                            double theDZ);
+
+  /// Creates linear edge by GeomAPI_Lin.
+  /// \param theLin line.
+  static std::shared_ptr<GeomAPI_Edge> line(const std::shared_ptr<GeomAPI_Lin> theLin);
+
+  /// Creates edge - axis of the given cylindrical face. The result axis edge is infinite
+  static std::shared_ptr<GeomAPI_Edge> cylinderAxis(
+    std::shared_ptr<GeomAPI_Shape> theCylindricalFace);
+
+  /// Creates linear edge in a form of a circle by a point and a circle radius
+  static std::shared_ptr<GeomAPI_Edge> lineCircle(std::shared_ptr<GeomAPI_Pnt> theCenter,
+                                                    std::shared_ptr<GeomAPI_Dir> theNormal,
+                                                    double theRadius);
+
+  /// Creates linear edge in a form of a circle by GeomAPI_Circle
+  static std::shared_ptr<GeomAPI_Edge> lineCircle(std::shared_ptr<GeomAPI_Circ> theCircle);
+
+  /// Creates linear edge in a form of a circle arc by a three points
+  static std::shared_ptr<GeomAPI_Edge> lineCircleArc(std::shared_ptr<GeomAPI_Pnt> theCenter,
+                                                       std::shared_ptr<GeomAPI_Pnt> theStartPoint,
+                                                       std::shared_ptr<GeomAPI_Pnt> theEndPoint,
+                                                       std::shared_ptr<GeomAPI_Dir> theNormal);
 };
 
 #endif