src/SketchPlugin/doc/lengthFeature.rst

   1 .. _sketchLength:
   2 .. |length.icon|    image:: images/length.png
   3
   4 Length constraint
   5 =================
   6
   7 Length constraint fixes the length of lines, such as standalone line or rectangle side.
   8
   9 To create a Length constraint in the active Sketch:
  10
  11 #. select in the Main Menu *Sketch - > Length* item  or
  12 #. click |length.icon| **Length** button in Sketch toolbar:
  13
  14 Property panel:
  15
  16 .. image:: images/Length_panel.png
  17    :align: center
  18
  19 Input fields:
  20
  21 - **Line** is the the line object selected in the view;
  22 - **Value** is a line length, can be modified to set the desirable value;
  23 - **Text location** is a position of the length value label relating to extension line (in the view):
  24    .. image:: images/location_left.png
  25       :align: left
  26    **Left** inserts text to the left of the length extension line;
  27
  28    .. image:: images/location_automatic.png
  29       :align: left
  30    **Automatic** inserts text in the middle of the length extension line if it has enough length, otherwise - to the left;
  31
  32    .. image:: images/location_right.png
  33       :align: left
  34    **Right** inserts text to the right of the length extension line.
  35
  36 When the line is selected, the length value is displayed in the property panel and in the view.
  37
  38 When creating the constraint, after selection of a line for the first time:
  39
  40 - drag the length presentation in the view to the desired position and click once;
  41 - set desirable length value in the input field in the view and press **Enter** or just press **Enter** to keep the current length.
  42
  43 .. image:: images/Length_field_view.png
  44    :align: center
  45
  46 .. centered::
  47    Length input in the view
  48
  49 **TUI Command**:
  50
  51 .. py:function:: Sketch_1.setLength(LineObject, Value)
  52
  53     :param object: A line.
  54     :param real: Length value.
  55     :return: Result object.
  56
  57 Result
  58 """"""
  59
  60 Created Length appears in the view.
  61
  62 .. image:: images/Length_res.png
  63            :align: center
  64
  65 .. centered::
  66    Length created
  67
  68 **See Also** a sample TUI Script of :ref:`tui_create_length` operation.