rectangle: add AddRectangleCentered function to python

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

diff --git a/src/SketchPlugin/doc/rectangleFeature.rst b/src/SketchPlugin/doc/rectangleFeature.rst
index c2a9abef88c960c34d7d60cc7102d8da4a9d1061..7244dc9ecf5af1d3f6d53b213bbb56b39892e9c5 100644 (file)
--- a/src/SketchPlugin/doc/rectangleFeature.rst
+++ b/src/SketchPlugin/doc/rectangleFeature.rst
@@ -15,9 +15,26 @@ To add a new Rectangle to the Sketch:
 #. select in the Main Menu *Sketch - > Rectangle* item  or
 #. click |rectangle.icon| **Rectangle** button in Sketch toolbar:
 
-The following property panel appears:
+There are 2 algorithms for creation of a Rectangle:
 
-.. figure:: images/Rectangle_panel.png
+.. figure:: images/rectangle_start_end.png
+   :align: left
+   :height: 24px
+
+**By start and end points** creates a rectangle with the given two corners points.
+
+.. figure:: images/rectangle_center_end.png
+   :align: left
+   :height: 24px
+
+**By center and end point** creates a rectangle with center and end point as corner.
+
+-------------------------------------------------------------------------------------------
+
+By start and end points
+""""""""""""""""""""""""""
+
+.. figure:: images/Rectangle_start_end_panel.png
    :align: center
 
    Rectangle
@@ -31,10 +48,33 @@ Start and end points coordinates are displayed in the property panel.
 
 .. py:function:: Sketch_1.addRectangle(X1, Y1, X2, Y2)
 
-    :param real: X1 value.
-    :param real: Y1 value.
-    :param real: X2 value.
-    :param real: Y2 value.
+    :param real: X1 corner X value.
+    :param real: Y1 corner Y value.
+    :param real: X2 opposite corner X value.
+    :param real: Y2 opposite corner Y value.
+    :return: Result object.
+
+By center and end point
+""""""""""""""""""""""""""
+
+.. figure:: images/Rectangle_center_end_panel.png
+   :align: center
+
+   Rectangle
+
+Click in the view once to set the center, then move the mouse and click a second time to set the corner.
+If an existing object is clicked, a constraint for the point will be created automatically.
+
+Center and end points coordinates are displayed in the property panel.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addRectangleCentered(X1, Y1, X2, Y2)
+
+    :param real: X1 center X value.
+    :param real: Y1 center Y value.
+    :param real: X2 corner X value.
+    :param real: Y2 corner Y value.
     :return: Result object.
 
 Result
@@ -42,9 +82,9 @@ Result
 
 Created rectangle appears in the view.
 
-.. figure:: images/Rectangle_res.png
+.. figure:: images/Rectangle_res2.png
    :align: center
 
-   Rectangle created
+   Rectangles created
 
 **See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation.