src/SketchPlugin/doc/verticalDistFeature.rst

   1 .. |distance_v.icon|    image:: images/distance_v.png
   2
   3 Vertical distance constraint
   4 ============================
   5
   6 Vertical Distance constraint fixes the distance between two points along the vertical axis.
   7
   8 The constraint can be defined between two points such as point object, line or arc end point, center of circle or arc.
   9
  10 To create a Vertical Distance constraint in the active Sketch:
  11
  12 #. select in the Main Menu *Sketch - > Vertical Distance* item  or
  13 #. click |distance_v.icon| **Vertical Distance** button in Sketch toolbar:
  14
  15 Property panel:
  16
  17 .. figure:: images/VerticalDistance_panel.png
  18    :align: center
  19
  20 .. |location_left| image:: images/location_left.png
  21 .. |location_auto| image:: images/location_automatic.png
  22 .. |location_right| image:: images/location_right.png
  23
  24 Input fields:
  25
  26 - **First point** is the first point selected in the view;
  27 - **Second point** is the second point selected in the view:
  28 - **Value** is a distance between the objects, can be modified to set the desirable value;
  29 - **Text location** is a position of the distance value label relating to extension line (in the view):
  30    | |location_left| **Left** inserts text to the left of the distance extension line:
  31    | |location_auto| **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left
  32    | |location_right| **Right** inserts text to the right of the distance extension line.
  33
  34 When both objects are selected, the vertical distance value is displayed in the property panel and in the view.
  35
  36 When creating the constraint, after selection of two objects for the first time:
  37
  38 - drag the Vertical distance presentation in the view to the desired position and click once;
  39 - set desirable vertical distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
  40
  41 .. figure:: images/VerticalDistance_field_view.png
  42    :align: center
  43
  44    Vertical Distance input in the view
  45
  46 **TUI Command**:
  47
  48 .. py:function:: Sketch_1.setVerticalDistance(FirstObject, SecondObject, Value)
  49
  50     :param object: First object.
  51     :param object: Second object.
  52     :param real: Value.
  53     :return: Result object.
  54
  55 Result
  56 """"""
  57
  58 Created Vertical Distance appears in the view.
  59
  60 .. figure:: images/VerticalDistance_res.png
  61    :align: center
  62
  63    Vertical Distance created
  64
  65 **See Also** a sample TUI Script of :ref:`tui_create_vdistance` operation.