src/SketchPlugin/doc/lineFeature.rst

   1 .. _sketchLine:
   2 .. |line.icon|    image:: images/Line.png
   3
   4 Line
   5 ====
   6
   7 Line feature creates a line segment by two points in the current Sketch.
   8
   9 To add a new Line to the Sketch:
  10
  11 #. select in the Main Menu *Sketch - > Line* item  or
  12 #. click |line.icon| **Line** button in Sketch toolbar:
  13
  14 The following property panel appears:
  15
  16 .. figure:: images/Line_panel.png
  17    :align: center
  18
  19    Line
  20
  21 Pick 2 points (start and end) in the view to create a Line. If an existing object is clicked, a constraint for the point will be created automatically.
  22
  23 Start and end points coordinates are displayed in the property panel.
  24
  25 **TUI Command**:
  26
  27 .. py:function:: Sketch_1.addLine(X1, Y1, X2, Y2)*
  28
  29     :param real: X1 value.
  30     :param real: Y1 value.
  31     :param real: X2 value.
  32     :param real: Y2 value.
  33     :return: Result object.
  34
  35 Result
  36 """"""
  37
  38 Created line appears in the view.
  39
  40 .. figure:: images/Line_res.png
  41    :align: center
  42
  43    Line created
  44
  45 **See Also** a sample TUI Script of :ref:`tui_create_line` operation.