src/SketchPlugin/doc/ellipseFeature.rst

   1 .. |ellipse.icon|    image:: images/ellipse.png
   2
   3 Ellipse
   4 =======
   5
   6 The feature Ellipse creates an ellipse in the current Sketch.
   7
   8 To add a new Ellipse to the Sketch:
   9
  10 #. select in the Main Menu *Sketch - > Ellipse* item  or
  11 #. click |ellipse.icon| **Ellipse** button in Sketch toolbar:
  12
  13 There are 2 algorithms for creation of an Ellipse:
  14
  15 .. image:: images/ellipse_cent_rad_32x32.png
  16    :align: left
  17 **By center and major semi-axes and passing points** creates an ellipse with the given center passing through given points.
  18
  19 .. image:: images/ellipse_axes_32x32.png
  20    :align: left
  21 **By major axis and passing point** creates an ellipse passing through the given three points.
  22
  23 By center and major semi-axes and passing points
  24 """"""""""""""""""""""""""""""""""""""""""""""""
  25
  26 .. image:: images/ellipse_panel_pt_rad.png
  27    :align: center
  28
  29 Click in the view once to set the center point, then move the mouse and click to set a point of a first semi-axis, then again move the mouse to set a point of a second semi-axis.
  30
  31 **TUI Command**:
  32
  33 .. py:function:: Sketch_1.addEllipse(CenterX, CenterY, MajorAxisX, MajorAxisY, PassedX, PassedY, True)
  34
  35     :param real: Center X.
  36     :param real: Center Y.
  37     :param real: Major Axis X.
  38     :param real: Major Axis Y.
  39     :param real: Passed X.
  40     :param real: Passed Y.
  41     :param boolean: True mentions that the first coordinates define the center of the ellipse.
  42     :return: Result object.
  43
  44 By major axis and passing point
  45 """""""""""""""""""""""""""""""
  46
  47 .. image:: images/ellipse_panel_3pt.png
  48    :align: center
  49
  50 Click in the view once to set a first point of a first axis, then move the mouse and click to set a second point of the first axis, then again move the mouse to set a point of a second semi-axis.
  51
  52 **TUI Command**:
  53
  54 .. py:function:: Sketch_1.addEllipse(MajorAxisStartX, MajorAxisStartY, MajorAxisEndX, MajorAxisEndY, PassedX, PassedY, False)
  55
  56     :param real: Major Axis Start X.
  57     :param real: Major Axis Start Y.
  58     :param real: Major Axis End X.
  59     :param real: Major Axis End Y.
  60     :param real: Passed X.
  61     :param real: Passed Y.
  62     :param boolean: False mentions that the first coordinates define the start point of major axis of the ellipse.
  63     :return: Result object.
  64
  65 Result
  66 """"""
  67
  68 Created ellipse appears in the view.
  69
  70 .. image:: images/ellipse_result.png
  71            :align: center
  72
  73 .. centered::
  74    Ellipse created
  75
  76
  77 **See Also** a sample TUI Script of :ref:`tui_create_ellipse` operation.