src/PrimitivesPlugin/doc/boxFeature.rst

   1 .. _box_feature:
   2
   3 Box
   4 ===
   5
   6 Box feature creates a box solid.
   7
   8 To create a Box in the active part:
   9
  10 #. select in the Main Menu *Primitives - > Box* item  or
  11 #. click **Box** button in the toolbar:
  12
  13 .. image:: images/box.png
  14    :align: center
  15
  16 .. centered::
  17    **Box**  button
  18
  19 There are 2 algorithms for creation of a Box:
  20
  21 .. image:: images/box_2pt_32x32.png
  22    :align: left
  23 **By dimensions**
  24
  25 .. image:: images/box_dxyz_32x32.png
  26    :align: left
  27 **By two points**
  28
  29
  30 By dimensions
  31 -------------
  32
  33 Box is created by dimensions along X, Y, Z axis starting from the origin.
  34
  35 .. image:: images/Box_dimensions.png
  36    :align: center
  37
  38 Input fields:
  39
  40 - **DX**, **DY**, **DZ** define dimensions of the box along the corresponding coordinate axes.
  41
  42 **TUI Command**:  *model.addBox(Part_doc, DX, DY, DZ)*
  43
  44 **Arguments**:    Part + 3 real values (dimensions at origin).
  45
  46 Result
  47 """"""
  48
  49 A solid box based on the origin of coordinates and with edges parallel to the coordinate axes.
  50
  51 .. image:: images/Box1.png
  52            :align: center
  53
  54 **See Also** a sample TUI Script of a :ref:`tui_create_boxdim` operation.
  55
  56 By two points
  57 -------------
  58
  59 Box is created by two points of the box diagonal.
  60
  61 .. image:: images/Box_2points.png
  62          :align: center
  63
  64 Input fields:
  65
  66 - **Point 1** and **Point 2**  define diagonal points of the box selected in 3D OCC viewer or object browser.
  67
  68 **TUI Command**:  *model.addBox(Part_doc, point1, point2)*
  69
  70 **Arguments**:   Part + 2 selected points (opposite vertices of the box)
  71
  72 Result
  73 """"""
  74
  75 A solid box based on two points and with edges parallel to the coordinate axes.
  76
  77 .. image:: images/Box2.png
  78            :align: center
  79
  80 .. centered::
  81    Created boxes
  82
  83 **See Also** a sample TUI Script of :ref:`tui_create_boxpnt` operation.