From: Grigory ZHIVOTOVSKY <gzy@salomex.nnov.opencascade.com>
Date: Mon, 13 Aug 2018 12:45:51 +0000 (+0300)
Subject: Help files update
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=6d416f68def50e0432520fd3fc0fa4c1fff21640;p=modules%2Fshaper.git

Help files update
---

diff --git a/.salomeport b/.salomeport
new file mode 100644
index 000000000..eafc9999e
--- /dev/null
+++ b/.salomeport
@@ -0,0 +1 @@
+2811
\ No newline at end of file
diff --git a/src/PrimitivesPlugin/doc/TUI_boxFeature.rst b/src/PrimitivesPlugin/doc/TUI_boxFeature.rst
new file mode 100644
index 000000000..78ae3ad40
--- /dev/null
+++ b/src/PrimitivesPlugin/doc/TUI_boxFeature.rst
@@ -0,0 +1,12 @@
+
+  .. _tui_create_box:
+
+Create Box
+==========
+
+.. literalinclude:: examples/box.py
+    :linenos:
+    :language: python
+
+:download:`Download this script <examples/box.py>` 
+   
diff --git a/src/PrimitivesPlugin/doc/boxFeature.rst b/src/PrimitivesPlugin/doc/boxFeature.rst
index 7ae1d7253..84cf765e8 100644
--- a/src/PrimitivesPlugin/doc/boxFeature.rst
+++ b/src/PrimitivesPlugin/doc/boxFeature.rst
@@ -1,17 +1,53 @@
 
+
 Box
 ===
 
+To create a Box in the active part:
+
+#. select in the Main Menu *Primitives - > Box* item  or
+#. click **Box** button in the toolbar
 
-.. image:: images/Box1.png
-  :align: center
+.. image:: images/Box_button.png
+   :align: center
 
 .. centered::
-  Create a box by dimensions
+   **Box**  button 
 
+There are 2 algorithms for creation of a Box:
+
+.. image:: images/Box_dimensions.png
+   :align: center
+	
+.. centered::
+   **By dimensions**
 
-.. image:: images/Box2.png
-  :align: center
+and 
 
+.. image:: images/Box_2points.png
+	   :align: center
+		   
 .. centered::
-  Create a box by two points
+   **By two points**  
+
+
+The description of input fields for **By dimensions** tab is given below:
+
+- **DX**, **DY**, **DZ** specify box dimensions along the coordinate axes for box with corner coinciding with coordinate origin.
+
+The description of input fields for **By two points** tab is given below:
+
+- **Point 1** and **Point 2** define the opposite corners of the box.
+
+**Apply** button creates box with defined parameters.
+  
+**Cancel** button cancels operation. 
+
+The Result of operation will be a SOLID. The edges of the box will be parallel to the coordinate axes.
+
+Name is assigned automatically:
+    
+* **Box_1**, **Box_2**, ... to Feature;
+* **Box_1_1**, **Box_2_1**, ... to Result.
+
+**See Also** a sample TUI Script of a :ref:`tui_create_box` operation.
diff --git a/src/PrimitivesPlugin/doc/examples/box.py b/src/PrimitivesPlugin/doc/examples/box.py
new file mode 100644
index 000000000..0b9b5e665
--- /dev/null
+++ b/src/PrimitivesPlugin/doc/examples/box.py
@@ -0,0 +1,14 @@
+# -*- 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, 20, 30, 40)
+Point_3 = model.addPoint(Part_1_doc, 40, 40, 50)
+Box_2 = model.addBox(Part_1_doc, model.selection("VERTEX", "Point_1"), model.selection("VERTEX", "Point_2"))
+model.do()
+model.end()
diff --git a/src/PrimitivesPlugin/doc/images/Box_2points.png b/src/PrimitivesPlugin/doc/images/Box_2points.png
new file mode 100644
index 000000000..d5131cd02
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Box_2points.png differ
diff --git a/src/PrimitivesPlugin/doc/images/Box_button.png b/src/PrimitivesPlugin/doc/images/Box_button.png
new file mode 100644
index 000000000..aaa604aad
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Box_button.png differ
diff --git a/src/PrimitivesPlugin/doc/images/Box_dimensions.png b/src/PrimitivesPlugin/doc/images/Box_dimensions.png
new file mode 100644
index 000000000..4ce8d31a8
Binary files /dev/null and b/src/PrimitivesPlugin/doc/images/Box_dimensions.png differ