src/SketchPlugin/doc/verticalDistFeature.rst

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