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 \b Radius and the \b Height. Also, you can optionally specify
  14 the \b Angle in order to create a portion of cylinder.
  15
  16 \n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height)</em>
  17 \n <b>Arguments:</b>  Name + 1 vertex + 1 vector + 2 values
  18 (Dimensions: radius and height).
  19
  20 \n <b>TUI Command:</b> <em>geompy.MakeCylinderA(Point, Axis, Radius, Height, Angle)</em>
  21 \n <b>Arguments:</b>  Name + 1 vertex + 1 vector + 3 values
  22 (Dimensions: radius, height and angle).
  23
  24 \image html cylinder1.png
  25
  26 \n Secondly, you can define a \b Cylinder by the given \b Radius and
  27 \b Height at the origin of coordinate system. The axis of the cylinder
  28 will be collinear to the OZ axis of the coordinate system.
  29 Similarly to first constructor, you can optionally specify the \b Angle
  30 in order to create a portion of cylinder.
  31
  32 \n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height)</em>
  33 \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius and
  34 height).
  35
  36 \n <b>TUI Command:</b> <em>geompy.MakeCylinderRHA(Radius, Height, Angle)</em>
  37 \n <b>Arguments:</b>  Name + 3 values
  38 (Dimensions at origin: radius, height and angle).
  39
  40 \image html cylinder2.png
  41
  42 <b>Example:</b>
  43
  44 \image html cylinders.png "Cylinders"
  45
  46 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  47 \ref tui_creation_cylinder "Primitives".
  48
  49 */