Salome HOME
Adding tests for "Box" primitive.
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_EdgeBuilder.h
index 0bd67621bc66ffeeb8b0b286949902e7a87f9dfe..b7b97aa7ee6818e881ed2106c38d0dd3e79adc09 100644 (file)
 class GEOMALGOAPI_EXPORT GeomAlgoAPI_EdgeBuilder
 {
  public:
-  /// Creates linear edge by two points
+  /// 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 edge - axis of the given cylindrical face
+
+  /// 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 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);