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>Angle</b> checkbox and field allow defining an angle to build a portion of cylinder.
  15 \n <b>TUI Command:</b> <em>geompy.MakeCylinder(Point, Axis, Radius, Height, Angle=2*pi)</em>
  16 \n <b>Arguments:</b>  Name + 1 vertex + 1 vector + 3 values
  17 (Dimensions: radius, height and angle).
  18
  19 \image html cylinder1.png
  20
  21 \n Secondly, you can define a \b Cylinder by the given radius and the
  22 height at  the origin of coordinate system. The axis of the cylinder
  23 will be collinear to the OZ axis of the coordinate system.
  24 <b>Angle</b> checkbox and field allow defining an angle to build a portion of cylinder.
  25 \n <b>TUI Command:</b> <em>geompy.MakeCylinderRH(Radius, Height, Angle=2*pi)</em>
  26 \n <b>Arguments:</b> Name + 2 values (Dimensions at origin: radius, height, angle).
  27
  28 \image html cylinder2.png
  29
  30 <b>Example:</b>
  31
  32 \image html cylinders.png "Cylinders"
  33
  34 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  35 \ref tui_creation_cylinder "Primitives".
  36
  37 */