Salome HOME
Ameliorate help pages
[modules/shaper.git] / src / SketchPlugin / doc / lineFeature.rst
index a182759764b7180bad66e7af0c072a40de0fddb1..a45094e7669cc4e34967b4334e16d0a26a381fd0 100644 (file)
@@ -1,10 +1,47 @@
+.. _sketchLine:
+.. |line.icon|    image:: images/line.png
 
 Line
 ====
 
+Line feature creates a line segment by two points in the current Sketch.
 
-.. image:: images/Line.png
+To add a new Line to the Sketch:
+
+#. select in the Main Menu *Sketch - > Line* item  or
+#. click |line.icon| **Line** button in Sketch toolbar:
+
+The following property panel appears:
+
+.. image:: images/Line_panel.png
   :align: center
 
 .. centered::
-  Create a line
+   Line
+
+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.
+
+Start and end points coordinates are displayed in the property panel.
+
+**TUI Command**:
+
+.. py:function:: Sketch_1.addLine(X1, Y1, X2, Y2)*
+
+    :param real: X1 value.
+    :param real: Y1 value.
+    :param real: X2 value.
+    :param real: Y2 value.
+    :return: Result object.
+
+Result
+""""""
+
+Created line appears in the view.
+
+.. image:: images/Line_res.png
+          :align: center
+
+.. centered::
+   Line created
+
+**See Also** a sample TUI Script of :ref:`tui_create_line` operation.