Salome HOME
Fixes and unit-tests basing on the manual tests
[modules/shaper.git] / src / SketchPlugin / doc / lineFeature.rst
1 .. _sketchLine:
2
3 Line
4 ====
5
6 Line feature creates a line segment by two points in the current Sketch.
7
8 To add a new Line to the Sketch:
9
10 #. select in the Main Menu *Sketch - > Line* item  or
11 #. click **Line** button in Sketch toolbar:
12
13 .. image:: images/line.png
14    :align: center
15
16 .. centered::
17    **Line**  button
18
19 The following property panel appears:
20
21 .. image:: images/Line_panel.png
22   :align: center
23
24 .. centered::
25    Line
26
27 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.
28
29 Start and end points coordinates are displayed in the property panel.
30
31 **TUI Command**:  *Sketch_1.addLine(X1, Y1, X2, Y2)*
32
33 **Arguments**:    4 values (coordinates of the start and end points).
34
35 Result
36 """"""
37
38 Created line appears in the view.
39
40 .. image:: images/Line_res.png
41            :align: center
42
43 .. centered::
44    Line created
45
46 **See Also** a sample TUI Script of :ref:`tui_create_line` operation.