Salome HOME
Merge remote branch 'origin/akl/22379'
[modules/geom.git] / doc / salome / gui / GEOM / input / creating_arc.doc
1 /*!
2
3 \page create_arc_page Arc
4
5 To create an \b Arc in the <b>Main Menu</b> select <b>New Entity - >
6 Basic - > Arc</b>
7
8 \n There are 2 algorithms to create an \b Arc in the 3D space.
9 \n The \b Result of each operation will be a GEOM_Object (edge).
10
11 \n Firstly, you can define an \b Arc by three \b Points that lie on it,
12 where Point1 is the starting point, Point2 is a middle point of the
13 arc and Point3 is the ending point of the arc.
14 \n <b>TUI Command:</b> <em>geompy.MakeArc(Point1, Point2, Point3)</em>
15 \n <b>Arguments:</b> Name + 3 vertices.
16
17 \image html arc.png
18
19 \n Secondly, you can define an \b Arc by \b Center, \b Start and \b End
20 points. The arc is built from the \b Start point to the \b End point. The
21 radius of the arc is defined by the distance between the \b Center point
22 and the \b Start point. The \b End point defines the angle of the arc. If
23 the distance between the \b Center point and the \b End point is not equal
24 to the radius, the arc will be built anyway.
25 \n \b Reverse radio button allows to change the direction of the arc.
26 \n <b>TUI Command:</b> <em>geompy.MakeArcCenter(Center Point, Start
27 Point, End Point, boolean Sense)</em>
28 \n <b>Arguments:</b> Name + 3 vertices + Boolean.
29
30 \image html arc2.png
31
32 Finally, it is possible to create an <b>Arc of Ellipse</b>, which is also done by three points: 
33 the Arguments <b>Point 1</b>, <b>Point 2</b> and the <b>Center Point</b>. The arc is built on the Ellipse that 
34 lies in the plane defined by the three points, with the center in the <b>Center point</b>. 
35 The major radius of the Ellipse is defined by the distance between the <b>Center Point</b> and 
36 the most remote Argument point. The minor radius is defined by the shortest distance between the 
37 other Argument point and the major radius.
38 \n <b>TUI Command:</b> <em>geompy.MakeArcOfEllipse(Center Point, First Point, Second Point)</em>
39 \n <b>Arguments:</b> Name + 3 vertices.
40
41 \image html arcofellipse2.png
42
43 \n <b>Examples:</b>
44
45 \image html arcsn.png
46 <center>Arc by three points lying on it.</center>
47
48 \image html arcsn1.png
49 <center>Arc by Start, End and Center.</center>
50
51 \image html arcsn2.png
52 <center>Reversed arc.</center>
53
54 \image html arcofellipse1.png
55 <center>Arc Of Ellipse.</center>
56
57 Our <b>TUI Scripts</b> provide you with useful examples of creation of
58 \ref tui_creation_arc "Basic Geometric Objects".
59 */
60