Salome HOME
Merge branch HELP_DOCUMENTATION_EDITING into master.
[modules/shaper.git] / src / BuildPlugin / doc / polylineFeature.rst
index 9d4a9e6c9e2a25a4bbf86fb3e07d42dfb203abe9..1e08de4e42cf8e510f5d2757225deba3e577581d 100644 (file)
@@ -2,9 +2,44 @@
 Polyline
 ========
 
+The feature **Polyline** 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 list of points and vertices selected in 3D OCC viewer. 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 presence of connection between the start and end points.
+
+Result
+""""""
+Result of operation is closed or open  Polyline.
+
+.. image:: images/CreatePolyline.png
+   :align: center
+
+.. centered::
+   Polyline
+
+**See Also** a sample TUI Script of a :ref:`tui_create_polyline` operation.
\ No newline at end of file