Salome HOME
Fix bunch of issues for B-splines (#3155, #3156, #3157, #3159)
[modules/shaper.git] / src / SketchPlugin / doc / verticalDistFeature.rst
index 5a98df3624c3a0477d868cd3c88025d26e314368..dac116da22f31382a699db43b3ff3f1fbb8df8ff 100644 (file)
@@ -1,3 +1,71 @@
+.. |distance_v.icon|    image:: images/distance_v.png
 
 Vertical distance constraint
 ============================
+
+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 a Vertical Distance constraint in the active Sketch:
+
+#. select in the Main Menu *Sketch - > Vertical Distance* item  or
+#. click |distance_v.icon| **Vertical Distance** button in Sketch toolbar:
+
+Property panel:
+
+.. image:: 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, 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
+   **Left** inserts text to the left of the distance extension line:
+
+   .. image:: images/location_automatic.png
+      :align: 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
+   **Right** inserts text to the right of the distance extension line.
+
+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 for the first time:
+
+- 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
+   :align: center
+
+.. centered::
+   Vertical Distance input in the view
+
+**TUI Command**:
+
+.. 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
+
+.. centered::
+   Vertical Distance created
+
+**See Also** a sample TUI Script of :ref:`tui_create_vdistance` operation.