doc/salome/gui/GEOM/input/creating_cylinder.doc

   1 /*!
   2
   3 \page create_cylinder_page Cylinder
   4
   5 \n To create a \b Cylinder in the <b>Main Menu</b> select <b>New
   6 Entity - > Primitives - > Cylinder</b>
   7
   8 \n There are 2 algorithms for creation of a \b Cylinder.
   9 \n The \b Result of each operation will be a GEOM_Object (SOLID).
  10
  11 \n Firstly, you can define a \b Cylinder by the <b>Base Point</b> (the central
  12 point of the cylinder base), the \b Vector (the axis of the cylinder),
  13 and its dimensions: the Radius and the Height.
  14 \n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height)</em>
  15 \n <b>Arguments:</b>  Name + 1 vertex + 1 vector + 2 values
  16 (Dimensions: radius and height).
  17
  18 \image html cylinder1.png
  19
  20 \n Secondly, you can define a \b Cylinder by the given radius and the
  21 height at  the origin of coordinate system. The axis of the cylinder
  22 will be collinear to the OZ axis of the coordinate system.
  23 \n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height)</em>
  24 \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and
  25 height).
  26
  27 \image html cylinder2.png
  28
  29 <b>Example:</b>
  30
  31 \image html cylinders.png
  32
  33 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  34 \ref tui_creation_cylinder "Primitives".
  35
  36 */