doc/salome/gui/GEOM/input/creating_ellipse.doc

   1 /*!
   2
   3 \page create_ellipse_page Ellipse
   4
   5 To create an \b Ellipse in the <b>Main Menu</b> select <b>New Entity - > Basic - > Ellipse</b>
   6
   7 \n You can define an \b Ellipse by its <b>Center</b> point, a \b
   8 Vector giving its normal, another vector specifying the direction of
   9 ellipse's <b>Major Axis</b> and its <b>Major</b> & <b>Minor Radiuses</b>.
  10 \n The \b Result of the operation will be a GEOM_Object (edge).
  11
  12 \note The parameters <b>Center</b>, <b>Vector</b> and <b>Major Axis</b>
  13 are optional. By default it is presumed that the <b>Center</b> point
  14 is located at the origin of the global coordinate system, the \b Vector
  15 corresponds to OZ axis of the global coordinate system and <b>Major Axis</b>
  16 corresponds to OX axis of the global coordinate system.
  17
  18 \note The actual direction of the major axis vector is defined as
  19 <EM> Vmaj' = (Vn * Vmaj) * Vn</em>, where \em Vn is a normal vector and
  20 \em Vmaj is an original vector of the major axis.
  21
  22 \n <b>TUI Command (without the major axis):</b> <em>geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor)</em>
  23 \n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
  24 the direction) + 1 X Radius + 1 Y Radius.
  25
  26 \n <b>TUI Command (with the major axis):</b> <em>geompy.MakeEllipseVec(Point, Vector, RadiusMajor, RadiusMinor, VectorMajor)</em>
  27 \n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
  28 the normal direction) + 1 X Radius + 1 Y Radius + 1 edge (for the
  29 major axis direction).
  30
  31 \image html ellipse.png
  32
  33 <b>Example:</b>
  34
  35 \image html ellipsesn.png "Ellipse"
  36
  37 Our <b>TUI Scripts</b> provide you with useful examples of creation of
  38 \ref tui_creation_ellipse "Basic Geometric Objects".
  39
  40 */