doc/salome/gui/GEOM/input/creating_box.doc

   1 /*!
   2
   3 \page create_box_page Box
   4
   5 To create a \b Box in the <b>Main Menu</b> select <b>New Entity - >
   6 Primitives - > Box</b>
   7
   8 \n There are 2 algorithms for creation of a \b Box.
   9 \n The \b Result of each operation will be a GEOM_Object (SOLID).
  10
  11 \n Firstly, you can define a \b Box by two specified \b Vertices (its
  12 opposite corners). The edges of the box will be parallel to the
  13 coordinate axes.
  14 \n <b>TUI Command:</b> <em>geompy.MakeBoxTwoPnt(Point1, Point2)</em>
  15 \n <b>Arguments:</b> Name + 2 vertices (opposite corners of the box).
  16
  17 \image html box1.png
  18
  19 \n Secondly, you can define a \b Box by specified dimensions along the
  20 coordinate axes and with edges, parallel to them.  The center of the
  21 box will be at point (DX/2, DY/2, DZ/2).
  22 \n <b>TUI Command:</b> <em>geompy.MakeBoxDXDYDZ(DX, DY, DZ)</em>
  23 \n <b>Arguments:</b> Name + 3 values (dimensions at origin).
  24
  25 \image html box2.png
  26
  27 \b NB! There is a third way to create a \b Box, which is currently
  28 accessible only via \b TUI commands.
  29 \n You can define a \b Box by the coordinates of two \b Vertices (in
  30 this way you don't need to create them in advance).
  31 \n <b>TUI Command:</b> <em>geompy.MakeBox(x1,y1,z1,x2,y2,z2)</em>
  32 \n <b>Arguments:</b> Name + X, Y and Z coordinates of both points.
  33 \note You can also use variables defined in the SALOME \b NoteBook
  34 to specify any numerical parameters of the box.
  35
  36 \image html box3.png
  37
  38 <b>Example:</b>
  39
  40 \image html boxes.png "Boxes"
  41
  42 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  43 \ref tui_creation_box "Primitives".
  44
  45 */