From: gzy <gzy@opencascade.com>
Date: Thu, 20 Sep 2018 14:27:33 +0000 (+0300)
Subject: polyline
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=6eb856d08410d45e773963261f83fc12e5a56f5e;p=modules%2Fshaper.git

polyline
---

diff --git a/src/BuildPlugin/doc/TUI_polylineFeature.rst b/src/BuildPlugin/doc/TUI_polylineFeature.rst
new file mode 100644
index 000000000..1099c4f5c
--- /dev/null
+++ b/src/BuildPlugin/doc/TUI_polylineFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_polyline:
+
+Create Polyline
+===============
+
+.. literalinclude:: examples/polyline.py 
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/polyline.py >` 
+   
diff --git a/src/BuildPlugin/doc/examples/polyline.py b/src/BuildPlugin/doc/examples/polyline.py
new file mode 100644
index 000000000..9596db811
--- /dev/null
+++ b/src/BuildPlugin/doc/examples/polyline.py
@@ -0,0 +1,15 @@
+# -*- coding: utf-8 -*-
+
+from salome.shaper import model
+
+model.begin()
+partSet = model.moduleDocument()
+Part_1 = model.addPart(partSet)
+Part_1_doc = Part_1.document()
+Box_1 = model.addBox(Part_1_doc, 10, 10, 10)
+Point_2 = model.addPoint(Part_1_doc, -10, -5, -7)
+Vertex_1 = model.addVertex(Part_1_doc, [model.selection("VERTEX", "Point_1")])
+Polyline_1_objects = [model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Left&Box_1_1/Bottom"), model.selection("VERTEX", "Box_1_1/Front&Box_1_1/Right&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Left&Box_1_1/Top"), model.selection("VERTEX", "Box_1_1/Back&Box_1_1/Right&Box_1_1/Bottom")]
+Polyline_1 = model.addPolyline3D(Part_1_doc, Polyline_1_objects, False)
+model.do()
+model.end()
diff --git a/src/BuildPlugin/doc/images/feature_polyline.png b/src/BuildPlugin/doc/images/feature_polyline.png
new file mode 100644
index 000000000..8ed9356e7
Binary files /dev/null and b/src/BuildPlugin/doc/images/feature_polyline.png differ
diff --git a/src/BuildPlugin/doc/polylineFeature.rst b/src/BuildPlugin/doc/polylineFeature.rst
index 9d4a9e6c9..f6f19416d 100644
--- a/src/BuildPlugin/doc/polylineFeature.rst
+++ b/src/BuildPlugin/doc/polylineFeature.rst
@@ -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
+
+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.
+
+**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/polyline.png
+   :align: center
+
+.. centered::
+   Polyline
+
+**See Also** a sample TUI Script of a :ref:`tui_create_polyline` operation.
\ No newline at end of file