Salome HOME
Correct documentation bugs, adapt for 'Read The Docs' theme (bos #18858)
[modules/shaper.git] / src / PrimitivesPlugin / doc / boxFeature.rst
index 7ae1d7253e826f9ece58170f215871a7597c33b8..a8d641e8c14f1b309755ca8f05ad0bcdb1e97cd4 100644 (file)
@@ -1,17 +1,97 @@
+.. _box_feature:
 
 Box
 ===
 
+.. |box.icon|    image:: images/box.png
+
+Box feature creates a box solid.
+
+To create a Box in the active part:
+
+#. select in the Main Menu *Primitives - > Box* item  or
+#. click |box.icon| **Box** button in the toolbar:
+
+There are 2 algorithms for creation of a Box:
+
+.. image:: images/box_dxyz_32x32.png
+   :align: left
+   :height: 24px
+
+**By dimensions** 
+
+.. image:: images/box_2pt_32x32.png
+   :align: left
+   :height: 24px
+
+**By two points** 
+
+--------------------------------------------------------------------------------
+
+By dimensions
+-------------
+
+Box is created by dimensions along X, Y, Z axis starting from the origin.
+
+.. image:: images/Box_dimensions.png
+   :align: center
+
+Input fields:
+
+- **DX**, **DY**, **DZ** define dimensions of the box along the corresponding coordinate axes. 
+
+**TUI Command**:
+
+.. py:function:: model.addBox(Part_doc, DX, DY, DZ)
+  
+    :param part: The current part object.
+    :param real: Size along X.
+    :param real: Size along Y.
+    :param real: Size along Z.
+    :return: Result object.
+
+Result
+""""""
+
+A solid box based on the origin of coordinates and with edges parallel to the coordinate axes.
 
 .. image:: images/Box1.png
-  :align: center
+          :align: center
 
-.. centered::
-  Create a box by dimensions
+**See Also** a sample TUI Script of a :ref:`tui_create_boxdim` operation.
 
+By two points
+-------------
 
-.. image:: images/Box2.png
-  :align: center
+Box is created by two points of the box diagonal.
+
+.. image:: images/Box_2points.png
+        :align: center
+
+Input fields:
+
+- **Point 1** and **Point 2**  define diagonal points of the box selected in 3D OCC viewer or object browser.
+  
+**TUI Command**:
 
+.. py:function:: model.addBox(Part_doc, point1, point2)
+
+    :param part: The current part object.
+    :param object: First vertex of diagonal.
+    :param object: Second vertex of diagonal.
+    :return: Result object.
+
+**Arguments**:   Part + 2 selected points (opposite vertices of the box)
+
+Result
+""""""
+
+A solid box based on two points and with edges parallel to the coordinate axes.
+
+.. image:: images/Box2.png
+          :align: center
+                  
 .. centered::
-  Create a box by two points
+   Created boxes
+
+**See Also** a sample TUI Script of :ref:`tui_create_boxpnt` operation.