Salome HOME
Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.
[modules/shaper.git] / src / SketchPlugin / doc / rectangleFeature.rst
index 3e90a11d7206041af0d29272279a29a515c118f8..c2a9abef88c960c34d7d60cc7102d8da4a9d1061 100644 (file)
@@ -1,50 +1,50 @@
-  .. _create_sketch_rectangle:
+.. _create_sketch_rectangle:
 
 Rectangle
 =========
 
-The feature Rectangle creates a rectangle by two opposite points in the current Sketch.
+.. |rectangle.icon|    image:: images/Rectangle.png
 
-The result is represented in the form of four Lines which compose a rectangle.
-Two of the lines have Vertical constraint and two others have Horizontal constraint.
+Rectangle feature creates a rectangle by two opposite points in the current Sketch.
 
-To add new Rectangle to the Sketch:
+The result is represented in form of four Lines which compose a rectangle.
+Two lines have Vertical constraint and two others have Horizontal constraint.
 
-#. select in the Main Menu *Sketch - > Rectangle* item  or
-#. click **Rectangle** button in Sketch toolbar:
-
-.. image:: images/rectangle.png
-   :align: center
+To add a new Rectangle to the Sketch:
 
-.. centered::
-   **Rectangle**  button
+#. select in the Main Menu *Sketch - > Rectangle* item  or
+#. click |rectangle.icon| **Rectangle** button in Sketch toolbar:
 
-The following property panel appears.
+The following property panel appears:
 
-.. image:: images/Rectangle_panel.png
-  :align: center
+.. figure:: images/Rectangle_panel.png
+   :align: center
 
-.. centered::
    Rectangle
 
 Click in the view once to set the first corner, then move the mouse and click a second time to set the opposite corner.
-In the case of click on an existing object constraint for the point will be created automatically.
+If an existing object is clicked, a constraint for the point will be created automatically.
 
 Start and end points coordinates are displayed in the property panel.
 
-**TUI Command**:  *Sketch_1.addRectangle(X1, Y1, X2, Y2)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.addRectangle(X1, Y1, X2, Y2)
 
-**Arguments**:    4 values (coordinates of the start and end points).
+    :param real: X1 value.
+    :param real: Y1 value.
+    :param real: X2 value.
+    :param real: Y2 value.
+    :return: Result object.
 
 Result
 """"""
 
 Created rectangle appears in the view.
 
-.. image:: images/Rectangle_res.png
-          :align: center
+.. figure:: images/Rectangle_res.png
+   :align: center
 
-.. centered::
    Rectangle created
 
-**See Also** a sample TUI Script of a :ref:`tui_create_rectangle` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_rectangle` operation.