Copyright update 2022

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

diff --git a/src/SketchPlugin/doc/circleFeature.rst b/src/SketchPlugin/doc/circleFeature.rst
index fa1abb235517347f61816d6a901d7aed83e1fa47..b729a6d4d9cc46ef4e537c8f46b16ac59c4a0c14 100644 (file)
--- a/src/SketchPlugin/doc/circleFeature.rst
+++ b/src/SketchPlugin/doc/circleFeature.rst
@@ -1,34 +1,35 @@
+.. |circle.icon|    image:: images/circle.png

 
 Circle
 ======
 
 The feature Circle creates a circle in the current Sketch.
 
 
 Circle
 ======
 
 The feature Circle creates a circle in the current Sketch.
 

-To add new Circle to the Sketch:
+To add a new Circle to the Sketch:

 
 #. select in the Main Menu *Sketch - > Circle* item  or
 
 #. select in the Main Menu *Sketch - > Circle* item  or

-#. click **Circle** button in Sketch toolbar:
-
-.. image:: images/circle.png
-   :align: center
-
-.. centered::
-   **Circle**  button
+#. click |circle.icon| **Circle** button in Sketch toolbar:

 
 There are 2 algorithms for creation of a Circle:
 
 
 There are 2 algorithms for creation of a Circle:
 

-.. image:: images/circle_pt_rad_32x32.png
+.. figure:: images/circle_pt_rad_32x32.png

    :align: left
    :align: left

+   :height: 24px
+

 **By center and passed point** creates a circle with the given center passing through the given point.
 
 **By center and passed point** creates a circle with the given center passing through the given point.
 

-.. image:: images/circle_3pt_32x32.png
+.. figure:: images/circle_3pt_32x32.png

    :align: left
    :align: left

+   :height: 24px
+

 **By three points** creates a circle passing through the given three points.
 
 **By three points** creates a circle passing through the given three points.
 

+-------------------------------------------------------------------------------------------
+

 By center and passed point
 """"""""""""""""""""""""""
 
 By center and passed point
 """"""""""""""""""""""""""
 

-.. image:: images/Circle_panel_pt_rad.png
+.. 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.
    :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.


@@ -37,14 +38,20 @@ Click in the view once to set the center point, then move the mouse and click a
 - 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.
 
 - 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.
 

-**TUI Command**:  *Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY)

 
 

-**Arguments**:    4 values (coordinates of the center and the passed point).
+    :param real: Start X.
+    :param real: Start Y.
+    :param real: Passed X.
+    :param real: Passed Y.
+    :return: Result object.

 
 By three points
 """""""""""""""
 
 
 By three points
 """""""""""""""
 

-.. image:: images/Circle_panel_3pt.png
+.. figure:: images/Circle_panel_3pt.png

    :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
    :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


@@ -53,34 +60,41 @@ and finally move the mouse and click a third time to set the last passed point.
 - 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.
 
 - 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.
 

-**TUI Command**:  *Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3)*
+**TUI Command**:

 
 

-**Arguments**:    6 values (coordinates of three points).
+.. py:function:: Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3)
+
+    :param real: Start X.
+    :param real: Start Y.
+    :param real: Passed X.
+    :param real: Passed Y.
+    :param real: End X.
+    :param real: End Y.
+    :return: Result object.

 
 Property panel in edition context
 """""""""""""""""""""""""""""""""
 
 The following property panel appears when the user selects an existing circle.
 
 
 Property panel in edition context
 """""""""""""""""""""""""""""""""
 
 The following property panel appears when the user selects an existing circle.
 

-.. image:: images/Circle_panel_edit.png
+.. figure:: images/Circle_panel_edit.png

    :align: center
 
    :align: center
 

-Note that the edition property panel doesn't show the creation algorithm used.
+Note that the edition property panel does not show the used creation algorithm.

 
 The panel shows:
 
 - center coordinates and radius (read-only).
 
 The panel shows:
 
 - center coordinates and radius (read-only).

-- auxiliary flag (could be modified).
+- auxiliary flag (can be modified).

 
 Result
 """"""
 
 Created circle appears in the view.
 
 
 Result
 """"""
 
 Created circle appears in the view.
 

-.. image:: images/Circle_res.png
-          :align: center
+.. figure:: images/Circle_res.png
+   :align: center

 
 

-.. centered::

    Circle created
 
    Circle created
 

-**See Also** a sample TUI Script of a :ref:`tui_create_circle` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_circle` operation.