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 Input fields:
  21
  22 - **First point** is the first point selected in the view;
  23 - **Second point** is the second point selected in the view;
  24 - **Value** is a distance between the objects, can be modified to set the desirable value;
  25 - **Text location** is a position of the distance value label relating to extension line (in the view):
  26    .. image:: images/location_left.png
  27       :align: left
  28    **Left** inserts text to the left of the distance extension line;
  29
  30    .. image:: images/location_automatic.png
  31       :align: left
  32    **Automatic** inserts text in the middle of the distance extension line if it has enough length, otherwise - to the left;
  33
  34    .. image:: images/location_right.png
  35       :align: left
  36    **Right** inserts text to the right of the distance extension line.
  37
  38 When both objects are selected, the horizontal distance value is displayed in the property panel and in the view.
  39
  40 When creating the constraint, after selection of two objects for the first time:
  41
  42 - drag the horizontal distance presentation in the view to the desired position and click once;
  43 - set desirable horizontal distance value in the input field in the view and press **Enter** or just press **Enter** to keep the current distance.
  44
  45 .. image:: images/HorizontalDistance_field_view.png
  46    :align: center
  47
  48 .. centered::
  49    Horizontal Distance input in the view
  50
  51 **TUI Command**:
  52
  53 .. py:function:: Sketch_1.setHorizontalDistance(FirstObject, SecondObject, Value)
  54
  55     :param object: An object 1.
  56     :param object: An object 2.
  57     :param real: Value.
  58     :return: Result object.
  59
  60 Result
  61 """"""
  62
  63 Created Horizontal Distance appears in the view.
  64
  65 .. image:: images/HorizontalDistance_res.png
  66            :align: center
  67
  68 .. centered::
  69    Horizontal Distance created
  70
  71 **See Also** a sample TUI Script of :ref:`tui_create_hdistance` operation.