doc/salome/gui/GEOM/input/creating_squareface.doc

   1 /*!
   2
   3 \page create_squareface_page Face
   4
   5 To create a \b Disk in the <b>Main Menu</b> select <b>New Entity - >
   6 Primitives - > Face</b>
   7
   8 \n There are 2 algorithms to create a \b Face in 3D space.
   9 \n The \b Result of each operation will be a GEOM_Object (Face).
  10
  11 \n Firstly, you can create a \b Face by the given height and width at the origin
  12 of coordinates. You can define the axis of the face by the orientation
  13 group buttons. There are three options to create a face in OXY, OYZ or OZX Planes.
  14 \n <b>TUI Command:</b> <em>geompy.MakeFaceHW(Height, Width, Orientation)</em>
  15 \n <b>Arguments:</b> Name + 3 values (Dimensions at origin: heigth, width and
  16 orientation).
  17 \n The orientation can be defined by "1", "2" or "3" values. This
  18 means that the Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
  19
  20 \image html face1.png
  21
  22 \n Secondly, you can define a \b Face by a \b Vector giving the face's normal to the center and
  23 \b Heigth and Width sizes.
  24 \n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Vector, Height, Width)</em>
  25 \n <b>Arguments:</b> Name + 1 Vector (normale to the center) + 2 doubles (to
  26 describe a face sizes).
  27 \n You can also create face from another selected face. Just turn the <b>Object Type</b> button
  28 to condition \b Face, then you can select a face object and set new values of
  29 Height and Width for the newly face. The created face will lie in the plane
  30 of the selected face.
  31 \n <b>TUI Command:</b> <em>geompy.MakeFaceObjHW(Face, Height, Width)</em>
  32 \n <b>Arguments:</b> Name + 1 Face + 2 parameters (to describe a face sizes).
  33
  34 \image html face2.png
  35
  36 <b>Example:</b>
  37 \image html faces.png
  38
  39 Our <b>TUI Scripts</b> provide you with useful examples of creating
  40 \ref tui_creation_face "Primitives".
  41
  42 */