src/SketchPlugin/doc/horizontalDistFeature.rst

   1 .. |distance_h.icon|    image:: images/distance_h.png
   2
   3 Horizontal distance constraint
   4 ==============================
   5
   6 Horizontal Distance constraint fixes the distance between two points along the horizontal 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 Horizontal Distance constraint in the active Sketch:
  11
  12 #. select in the Main Menu *Sketch - > Horizontal Distance* item  or
  13 #. click |distance_h.icon| **Horizontal Distance** button in Sketch toolbar:
  14
  15 Property panel:
  16
  17 .. image:: images/HorizontalDistance_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 horizontal 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 horizontal distance presentation in the view to the desired position and click once;
  39 - set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
  40
  41 .. image:: images/HorizontalDistance_field_view.png
  42    :align: center
  43
  44 .. centered::
  45    Horizontal Distance input in the view
  46
  47 **TUI Command**:
  48
  49 .. py:function:: Sketch_1.setHorizontalDistance(FirstObject, SecondObject, Value)
  50
  51     :param object: An object 1.
  52     :param object: An object 2.
  53     :param real: Value.
  54     :return: Result object.
  55
  56 Result
  57 """"""
  58
  59 Created Horizontal Distance appears in the view.
  60
  61 .. image:: images/HorizontalDistance_res.png
  62            :align: center
  63
  64 .. centered::
  65    Horizontal Distance created
  66
  67 **See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation.