doc/salome/gui/GEOM/input/creating_cone.doc

   1 /*!
   2
   3 \page create_cone_page Cone
   4
   5 \n To create a \b Cone in the <b>Main Menu</b> select <b>New Entity - > Primitives - > Cone</b>
   6
   7 \n There are two algorithms for creation of a \b Cone.
   8 \n The \b Result of each operation will be a GEOM_Object (SOLID).
   9
  10
  11
  12 \n Firstly, you can define a \b Cone by the <b>Base Point</b> (the
  13 central point of the cone base), the \b Axis, the \b Height and the
  14 first and the second \b Radiuses.
  15 \n <b>TUI Command:</b> <em>geompy.MakeCone(Point, Axis, Radius1,
  16 Radius2, height)</em>
  17 \n <b>Arguments:</b> Name + 1 vertex + 1 vector (for direction) + 3
  18 values (Radius of the base part, radius of the upper part, height).
  19
  20 \image html cone1.png
  21
  22 \n Secondly, you can define a \b Cone with the center at the origin of
  23 coordinates by its \b Height and \b Radiuses. The \b Axis of the \b
  24 Cone will be collinear to the OZ axis of the coordinate system.
  25 \n <b>TUI Command:</b> <em>geompy.MakeConeR1R2H(Radius1, Radius2, Height)</em>
  26 \n <b>Arguments:</b> Name + 3 values (Radius of the base part, radius
  27 of the upper part, height).
  28
  29 \image html cone2.png
  30
  31 \note If both radiuses are non-zero, the \b Cone will be truncated. If
  32 the radiuses are equal, a \b Cylinder will be created instead.
  33
  34 <b>Example:</b>
  35
  36 \image html cones.png "Normal and truncated cones"
  37
  38 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  39 \ref tui_creation_cone "Primitives".
  40
  41 */