Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / SketchPlugin / doc / arcEllipseFeature.rst
1 .. |earc.icon|    image:: images/elliptic_arc.png
2
3 Elliptic Arc
4 ============
5
6 Elliptic Arc feature creates an elliptic arc segment in the current Sketch.
7
8 To add a new Elliptic Arc to the Sketch:
9
10 #. select in the Main Menu *Sketch - > Elliptic Arc* item  or
11 #. click |earc.icon| **Elliptic Arc** button in Sketch toolbar:
12
13 The following property panel appears:
14
15 .. figure:: images/elliptic_arc_panel.png
16    :align: center
17
18 Click in the view to set the center point, then move the mouse and click a second time to set a point of a one semi-axis, then click to set a starting point of the arc and then to set an end point of the arc.
19
20 **TUI Command**:
21
22 .. py:function:: Sketch_1.addEllipticArc(CenterX, CenterY, FocusX, FocusY, StartX, StartY, EndX, EndY, Inversed)
23
24     :param real: Center X.
25     :param real: Center Y.
26     :param real: Focus X.
27     :param real: Focus Y.
28     :param real: Start X.
29     :param real: Start Y.
30     :param real: End X.
31     :param real: End Y.
32     :param boolean: Is inversed.
33     :return: Result object.
34
35 Result
36 """"""
37
38 Created elliptic arc appears in the view.
39
40 .. figure:: images/elliptic_arc_result.png
41    :align: center
42
43    Elliptic arc created
44
45 **See Also** a sample TUI Script of :ref:`tui_create_elliptic_arc` operation.