X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2Fdoc%2FellipseFeature.rst;h=8f0a8222898a7fe1cdd702dbf34218ef661e5f50;hb=cdbbde4803e9c320204d537d22af4ac7ef024962;hp=bc751c01e6e451c91dfe809522f5e3b0cc153fcd;hpb=547a3952b37fe76f0d4e031a7d8a943ac6a45bb5;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/doc/ellipseFeature.rst b/src/SketchPlugin/doc/ellipseFeature.rst index bc751c01e..8f0a82228 100644 --- a/src/SketchPlugin/doc/ellipseFeature.rst +++ b/src/SketchPlugin/doc/ellipseFeature.rst @@ -1,3 +1,82 @@ +.. |ellipse.icon| image:: images/ellipse.png - Ellipse - ======= +Ellipse +======= + +The feature Ellipse creates an ellipse in the current Sketch. + +To add a new Ellipse to the Sketch: + +#. select in the Main Menu *Sketch - > Ellipse* item or +#. click |ellipse.icon| **Ellipse** button in Sketch toolbar: + +There are 2 algorithms for creation of an Ellipse: + +.. figure:: images/ellipse_cent_rad_32x32.png + :align: left + :height: 24px + +**By center and major semi-axes and passing points** creates an ellipse with the given center passing through given points. + +.. figure:: images/ellipse_axes_32x32.png + :align: left + :height: 24px + +**By major axis and passing point** creates an ellipse passing through the given three points. + +------------------------------------------------------------------------------------------- + +By center and major semi-axes and passing points +"""""""""""""""""""""""""""""""""""""""""""""""" + +.. figure:: images/ellipse_panel_pt_rad.png + :align: center + +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. + +**TUI Command**: + +.. py:function:: Sketch_1.addEllipse(CenterX, CenterY, MajorAxisX, MajorAxisY, PassedX, PassedY, True) + + :param real: Center X. + :param real: Center Y. + :param real: Major Axis X. + :param real: Major Axis Y. + :param real: Passed X. + :param real: Passed Y. + :param boolean: True mentions that the first coordinates define the center of the ellipse. + :return: Result object. + +By major axis and passing point +""""""""""""""""""""""""""""""" + +.. figure:: images/ellipse_panel_3pt.png + :align: center + +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. + +**TUI Command**: + +.. py:function:: Sketch_1.addEllipse(MajorAxisStartX, MajorAxisStartY, MajorAxisEndX, MajorAxisEndY, PassedX, PassedY, False) + + :param real: Major Axis Start X. + :param real: Major Axis Start Y. + :param real: Major Axis End X. + :param real: Major Axis End Y. + :param real: Passed X. + :param real: Passed Y. + :param boolean: False mentions that the first coordinates define the start point of major axis of the ellipse. + :return: Result object. + +Result +"""""" + +Created ellipse appears in the view. + +.. figure:: images/ellipse_result.png + :align: center + + Ellipse created + + +**See Also** a sample TUI Script of :ref:`tui_create_ellipse` operation.