Salome HOME
Corrections for the user's manual from the English language point of view
[modules/shaper.git] / src / BuildPlugin / doc / polylineFeature.rst
index 9d4a9e6c9e2a25a4bbf86fb3e07d42dfb203abe9..6df40143d04711e02eb5cc12df009e259f0b06b7 100644 (file)
@@ -1,10 +1,46 @@
+.. _buildPolyline:
 
 Polyline
 ========
 
+Polyline feature creates a wire.
+
+To create a Polyline in the active part:
+
+#. select in the Main Menu *Build - > Polyline* item  or
+#. click **Polyline** button in the toolbar
+
+.. image:: images/feature_polyline.png
+   :align: center
+
+.. centered::
+   **Polyline** button 
+
+The following property panel appears.
 
 .. image:: images/Polyline.png
   :align: center
 
 .. centered::
-  Create a polyline
+  Polyline property panel
+
+Input fields:
+
+- **Points and vertices** panel contains a list of points and vertices selected in 3D OCC viewer. The Polyline consequently connects points;
+- **Closed** check-box turns on/off connection of the start and end points to make polyline closed/opened.
+
+**TUI Commands**:  *model.addPolyline3D(Part_1_doc, Polyline_objects, Key)*
+
+**Arguments**: 1 part+ list of vertices selected in format *model.selection("VERTEX", "Point")* + Boolean key defining  connection between the start and end points.
+
+Result
+""""""
+The result of the operation is a closed or open Polyline.
+
+.. image:: images/CreatePolyline.png
+   :align: center
+
+.. centered::
+   Polyline
+
+**See Also** a sample TUI Script of :ref:`tui_create_polyline` operation.
\ No newline at end of file