Salome HOME
Cosmetics. Move XML files to the separate folder inside a corresponding project in VS.
[modules/shaper.git] / src / SketchPlugin / doc / verticalDistFeature.rst
index 6a512e3256757684937b9dfe4a0a3dd8e272b246..9180c6770f04526a19b883a00479b28d44adfcc2 100644 (file)
@@ -1,71 +1,65 @@
+.. |distance_v.icon|    image:: images/distance_v.png
 
 Vertical distance constraint
 ============================
 
-Vertical Distance constraint fixes distance between two points along the vertical axis.
+Vertical Distance constraint fixes the distance between two points along the vertical 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 Vertical Distance constraint in the active Sketch:
+To create Vertical Distance constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Vertical Distance* item  or
-#. click **Vertical Distance** button in Sketch toolbar:
-
-.. image:: images/distance_v.png
-   :align: center
-
-.. centered::
-   **Vertical Distance**  button
+#. click |distance_v.icon| **Vertical Distance** button in Sketch toolbar:
 
 Property panel:
 
-.. image:: images/VerticalDistance_panel.png
+.. figure:: images/VerticalDistance_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 vertical distance value is displayed in the property panel and in the view.
+When both objects are selected, the vertical 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 Vertical distance presentation in the view to the desired position (by move mouse and click once)
-- set desirable vertical distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
+- drag the Vertical distance presentation in the view to the desired position and click once;
+- set desirable vertical distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
 
-.. image:: images/VerticalDistance_field_view.png
+.. figure:: images/VerticalDistance_field_view.png
    :align: center
 
-.. centered::
    Vertical Distance input in the view
 
-**TUI Command**: *Sketch_1.setVerticalDistance(FirstObject, SecondObject, Value)*
+**TUI Command**:
 
-**Arguments**:  2 objects + vertical distance value
+.. py:function:: Sketch_1.setVerticalDistance(FirstObject, SecondObject, Value)
+
+    :param object: First object.
+    :param object: Second object.
+    :param real: Value.
+    :return: Result object.
 
 Result
 """"""
 
 Created Vertical Distance appears in the view.
 
-.. image:: images/VerticalDistance_res.png
-          :align: center
+.. figure:: images/VerticalDistance_res.png
+   :align: center
 
-.. centered::
    Vertical Distance created
 
-**See Also** a sample TUI Script of :ref:`tui_create_vdistance` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_vdistance` operation.