Salome HOME
Restore translations
[modules/shaper.git] / src / SketchPlugin / doc / distanceFeature.rst
index 32b8eef376de67894b723bb6d2f27e58fe6619f0..72e655ff0dd1445a99d79e57845de9ba6493553d 100644 (file)
@@ -1,21 +1,16 @@
+.. |distance.icon|    image:: images/distance.png
 
 Distance constraint
 ===================
 
 
 Distance constraint
 ===================
 
-Distance constraint fixes distance between two objects.
+Distance constraint fixes the distance between two objects.
 
 The constraint can be defined between such objects as point, line, line or arc end point, center of circle or arc.
 
 
 The constraint can be defined between such objects as point, line, line or arc end point, center of circle or arc.
 
-To create Distance constraint in the active Sketch:
+To create Distance constraint in the active Sketch:
 
 #. select in the Main Menu *Sketch - > Distance* item  or
 
 #. select in the Main Menu *Sketch - > Distance* item  or
-#. click **Distance** button in Sketch toolbar:
-
-.. image:: images/distance.png
-   :align: center
-
-.. centered::
-   **Distance**  button
+#. click |distance.icon| **Distance** button in Sketch toolbar:
 
 Property panel:
 
 
 Property panel:
 
@@ -24,29 +19,29 @@ Property panel:
 
 Input fields:
 
 
 Input fields:
 
-- **First object** is the first object selected in the view
-- **Second object** is the second object 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)
+- **First object** is the first object selected in the view;
+- **Second object** is the second object 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):
    .. image:: images/location_left.png
       :align: left
    .. image:: images/location_left.png
       :align: left
-   **Left** inserts text at the left of the distance extension line.
+   **Left** inserts text to the left of the distance extension line;
 
    .. image:: images/location_automatic.png
       :align: left
 
    .. 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.
+   **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
 
    .. image:: images/location_right.png
       :align: left
 
    .. image:: images/location_right.png
       :align: left
-   **Right** inserts text to the right of the distance extension line.
-- **Keep orientation** fixes the relative position between selected objects
+   **Right** inserts text to the right of the distance extension line;
+- **Keep orientation** fixes the relative position between selected objects.
 
 
-When both objects are selected distance value is displayed in the property panel and in the view.
+When both objects are selected, the 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 a constraint after selection of two objects for the first time:
 
 
-- drag the distance presentation in the view to the desired position (by move mouse and click once)
-- set desirable distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance
+- drag the distance presentation in the view to the desired position and click once;
+- set the desirable distance value in the input field and press **Enter** or just press **Enter** to keep the current distance.
 
 .. image:: images/Distance_field_view.png
    :align: center
 
 .. image:: images/Distance_field_view.png
    :align: center
@@ -54,9 +49,15 @@ When creating the constraint, after selection of two objects at the first time:
 .. centered::
    Distance input in the view
 
 .. centered::
    Distance input in the view
 
-**TUI Command**: *Sketch_1.setDistance(FirstObject, SecondObject, Value, KeepOrientation)*
+**TUI Command**:
+
+.. py:function:: Sketch_1.setDistance(FirstObject, SecondObject, Value, KeepOrientation)
 
 
-**Arguments**:  2 objects + distance value + keep orientation flag
+    :param object: First object.
+    :param object: Second object.
+    :param real: Value.
+    :param boolean: Keep orientation flag.
+    :return: Result object.
 
 Result
 """"""
 
 Result
 """"""
@@ -69,4 +70,4 @@ Created Distance appears in the view.
 .. centered::
    Distance created
 
 .. centered::
    Distance created
 
-**See Also** a sample TUI Script of :ref:`tui_create_distance` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_distance` operation.