doc/salome/gui/GEOM/input/creating_disk.doc

   1 /*!
   2
   3 \page create_disk_page Disk
   4
   5 A primitive called disk is a round plane with a certain radius and orientation
   6
   7 To create a \b Disk in the <b>Main Menu</b> select <b>New Entity - >
   8 Primitives - > Disk</b>
   9
  10 \n There are 3 algorithms to create a \b Disk in 3D space.
  11 \n The \b Result of each operation will be a GEOM_Object (face).
  12
  13 \n Firstly, you can create a \b Disk at the origin
  14 of coordinates defining its radius and selecting the orientation of its axis with radio
  15  buttons (OXY, OYZ or OZX).This
  16 means that the Disk will lie in "OXY", "OYZ" or "OZX" plane correspondingly.
  17 \n <b>TUI Command:</b> <em>geompy.MakeDiskR(Radius, Orientation)</em>
  18 \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and
  19 orientation).
  20
  21 \image html disk1.png
  22
  23 \n Secondly, you can define a \b Disk by a <b>Center Point</b>, a \b
  24 Vector defining the normal of a circle and a \b Radius.
  25 \n <b>TUI Command:</b> <em>geompy.MakeDiskPntVecR(Point, Vector,
  26 Radius)</em>
  27 \n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
  28 the direction) + Radius.
  29
  30 \image html disk2.png
  31
  32 \n Finally, you can define a \b Disk by three \b Points that lie on its boundary.
  33 \n <b>TUI Command:</b> <em>geompy.MakeDiskThreePnt(Point1, Point2, Point3)</em>
  34 \n <b>Arguments:</b> Name + 3 points which will form the disk.
  35
  36 \image html disk3.png
  37
  38 <b>Example:</b>
  39 \image html disks.png "Disks"
  40
  41 Our <b>TUI Scripts</b> provide you with useful examples of creating
  42 \ref tui_creation_disk "Primitives".
  43
  44 */