Salome HOME
[bos #35151][EDF](2023-T1) Centered rectangle.
[modules/shaper.git] / src / SketchPlugin / doc / horizontalDistFeature.rst
index f6981cb2a60a329eedbbc01a5ede169f8b19673a..7a86013b1ec869d0c084ba33ba21f961db63c641 100644 (file)
@@ -1,71 +1,65 @@
+.. |distance_h.icon|    image:: images/distance_h.png
 
 Horizontal distance constraint
 ==============================
 
-Horizontal Distance constraint fixes distance between two points along the horizontal axis.
+Horizontal Distance constraint fixes the distance between two points along the horizontal axis.
 
 The constraint can be defined between two points such as point object, line or arc end point, center of circle or arc.
 
-To create Horizontal Distance constraint in the active Sketch:
+To create Horizontal Distance constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Horizontal Distance* item  or
-#. click **Horizontal Distance** button in Sketch toolbar:
-
-.. image:: images/distance_h.png
-   :align: center
-
-.. centered::
-   **Horizontal Distance**  button
+#. click |distance_h.icon| **Horizontal Distance** button in Sketch toolbar:
 
 Property panel:
 
-.. image:: images/HorizontalDistance_panel.png
+.. figure:: images/HorizontalDistance_panel.png
    :align: center
 
-Input fields:
-
-- **First point** is the first point selected in the view
-- **Second point** is the second point selected in the view
-- **Value** is a distance between the objects, could be modified to set the desirable value
-- **Text location** is a position of the distance value label relating to extension line (in the view)
-   .. image:: images/location_left.png
-      :align: left
-   **Left** inserts text at the left of the distance extension line.
+.. |location_left| image:: images/location_left.png
+.. |location_auto| image:: images/location_automatic.png
+.. |location_right| image:: images/location_right.png
 
-   .. image:: images/location_automatic.png
-      :align: left
-   **Automatic** inserts text at the middle of the distance extension line if it has enough length, otherwise - to the left.
+Input fields:
 
-   .. image:: images/location_right.png
-      :align: left
-   **Right** inserts text to the right of the distance extension line.
+- **First point** is the first point selected in the view;
+- **Second point** is the second point selected in the view;
+- **Value** is a distance between the objects, can be modified to set the desirable value;
+- **Text location** is a position of the distance value label relating to extension line (in the view):
+   | |location_left| **Left** inserts text to the left of the distance extension line;
+   | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
+   | |location_right| **Right** inserts text to the right of the distance extension line.
 
-When both objects are selected horizontal distance value is displayed in the property panel and in the view.
+When both objects are selected, the horizontal distance value is displayed in the property panel and in the view.
 
-When creating the constraint, after selection of two objects at the first time:
+When creating the constraint, after selection of two objects for the first time:
 
-- drag the horizontal distance presentation in the view to the desired position (by move mouse and click once)
-- set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
+- drag the horizontal distance presentation in the view to the desired position and click once;
+- set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
 
-.. image:: images/HorizontalDistance_field_view.png
+.. figure:: images/HorizontalDistance_field_view.png
    :align: center
 
-.. centered::
    Horizontal Distance input in the view
 
-**TUI Command**: *Sketch_1.setHorizontalDistance(FirstObject, SecondObject, Value)*
+**TUI Command**:
 
-**Arguments**:  2 objects + horizontal distance value
+.. py:function:: Sketch_1.setHorizontalDistance(FirstObject, SecondObject, Value)
+
+    :param object: An object 1.
+    :param object: An object 2.
+    :param real: Value.
+    :return: Result object.
 
 Result
 """"""
 
 Created Horizontal Distance appears in the view.
 
-.. image:: images/HorizontalDistance_res.png
-          :align: center
+.. figure:: images/HorizontalDistance_res.png
+   :align: center
 
-.. centered::
    Horizontal Distance created
 
-**See Also** a sample TUI Script of a :ref:`tui_create_hdistance` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation.