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