bos#35152 [EDF] (2023-T1) Sketch Circle should allow user to position construction...

[modules/shaper.git] / src / SketchPlugin / doc / circleFeature.rst

diff --git a/src/SketchPlugin/doc/circleFeature.rst b/src/SketchPlugin/doc/circleFeature.rst
index b729a6d4d9cc46ef4e537c8f46b16ac59c4a0c14..fa24e9e29f0d68ad2f963454652f78afd8270c82 100644 (file)
--- a/src/SketchPlugin/doc/circleFeature.rst
+++ b/src/SketchPlugin/doc/circleFeature.rst
@@ -3,7 +3,7 @@
 Circle
 ======
 
-The feature Circle creates a circle in the current Sketch.
+The feature Circle creates a circle and point on line in the current Sketch.
 
 To add a new Circle to the Sketch:
 
@@ -32,14 +32,31 @@ By center and passed point
 .. figure:: images/Circle_panel_pt_rad.png
    :align: center
 
-Click in the view once to set the center point, then move the mouse and click a second time to set the passed point.
+Click in the view once to set the center point, then move the mouse and click a second time to set the passed point and finally 
+click third time to set point on the line.
 
 - When entering a center point by selecting either a point or a segment, a Coincident constraint is created.
 - When entering a passing point by selecting a point, a Coincident constraint is also created.
 - When entering a passing point by selecting a segment, a Tangent constraint is created.
 
+- Point on the line show sewing point for circle. If rotate this point, sewing point also will be changed 
+
 **TUI Command**:
 
+.. py:function:: Sketch_1.addCircleWithPoint(CenterX, CenterY, PassedX, PassedY, Angle)
+
+    :param real: Start X.
+    :param real: Start Y.
+    :param real: Passed X.
+    :param real: Passed Y.
+    :param real: Rotation angle for sewing point
+    :return: Result object.
+
+.. py:function:: SketchCircle_1.createdPoint()
+   :return: Created point on circle line
+
+This method is deprecated, please, use addCircleWithPoint
+
 .. py:function:: Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY)
 
     :param real: Start X.
@@ -55,13 +72,31 @@ By three points
    :align: center
 
 Click in the view once to set the first passed point, then move the mouse and click a second time to set the second passed point
-and finally move the mouse and click a third time to set the last passed point.
+then move the mouse and click a third time to set the last passed point, and finally 
+click last time to set point on the line.
 
 - When entering a passing point by selecting a point, a Coincident constraint is created.
 - When entering a passing point by selecting a segment, a Tangent constraint is created.
 
+- Point on the line show sewing point for circle. If rotate this point, sewing point also will be changed 
 **TUI Command**:
 
+.. py:function:: Sketch_1.addCircleWithPoint(X1, Y1, X2, Y2, X3, Y3, Angle)
+
+    :param real: Start X.
+    :param real: Start Y.
+    :param real: Passed X.
+    :param real: Passed Y.
+    :param real: End X.
+    :param real: End Y.
+    :param real: Rotation angle for sewing point
+    :return: Result object.
+
+.. py:function:: SketchCircle_1.createdPoint()
+   :return: Created point on circle line
+
+This method is deprecated, please, use addCircleWithPoint
+
 .. py:function:: Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3)
 
     :param real: Start X.