Box
===
-The feature Box creates a box solid.
+.. |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** button in the toolbar:
-
-.. image:: images/box.png
- :align: center
-
-.. centered::
- **Box** button
+#. click |box.icon| **Box** button in the toolbar:
There are 2 algorithms for creation of a Box:
-.. image:: images/box_2pt_32x32.png
+.. image:: images/box_dxyz_32x32.png
:align: left
+ :height: 24px
+
**By dimensions**
-.. image:: images/box_dxyz_32x32.png
+.. 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.
Input fields:
-- **DX**, **DY**, **DZ** define sizes of the box along corresponding coordinate axes.
+- **DX**, **DY**, **DZ** define dimensions of the box along the corresponding coordinate axes.
+
+**TUI Command**:
-**TUI Command**: *model.addBox(Part_doc, DX, DY, DZ)*
+.. py:function:: model.addBox(Part_doc, DX, DY, DZ)
-**Arguments**: Part + 3 real values (dimensions at origin).
+ :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
+
+**See Also** a sample TUI Script of a :ref:`tui_create_boxdim` operation.
By two points
-"""""""""""""
+-------------
Box is created by two points of the box diagonal.
Input fields:
-- **Point 1** and **Point 2** define diagonal points of the box selected in 3D OCC viewer or object browser.
+- **Point 1** and **Point 2** define diagonal points of the box selected in 3D OCC viewer or object browser.
-**TUI Command**: *model.addBox(Part_doc, point1, point2)*
+**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
""""""
-The edges of the created boxes are parallel to the coordinate axes.
+A solid box based on two points and with edges parallel to the coordinate axes.
-.. image:: images/Boxes.png
+.. image:: images/Box2.png
:align: center
.. centered::
- Boxes created
+ Created boxes
-**See Also** a sample TUI Script of a :ref:`tui_create_box` operation.
\ No newline at end of file
+**See Also** a sample TUI Script of :ref:`tui_create_boxpnt` operation.
