Salome HOME
Update from BR_V5_DEV 13Feb2009
[modules/geom.git] / 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 Point</b>, a \b
8 Vector giving its normal, and its <b>Major & Minor Radiuses</b>.
9 \n The \b Result of the operation will be a GEOM_Object (edge).
10
11 \n <b>TUI Command:</b> <em>geompy.MakeEllipse(Point, Vector, RadiusMajor, RadiusMinor)</em>
12 \n <b>Arguments:</b> Name + 1 vertex (for the center) + 1 edge (for
13 the direction) + 1 X Radius + 1 Y Radius.
14
15 \note By default it is presumed that the <b>Center Point</b> is located at the  Origin of the global
16 coordinate system, and the  \b Vector corresponds to OZ axis of the global
17 coordinate system.
18
19 \image html ellipse.png
20
21 <b>Example:</b>
22
23 \image html ellipsesn.png "Ellipse"
24
25 Our <b>TUI Scripts</b> provide you with useful examples of creation of
26 \ref tui_creation_ellipse "Basic Geometric Objects".
27
28 */