X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSketchPlugin%2Fdoc%2FcircleFeature.rst;h=1db82933128b8cebdb7484aa21cf40574f5e9a00;hb=0fcd69345a4dfdb31e252574c68bc70e123999e8;hp=8752d00a6a8dc209583e11fdc4c785c9c9e81b83;hpb=b7ec3c27f028060b3c42b7da6fa3dfe962fe26e4;p=modules%2Fshaper.git diff --git a/src/SketchPlugin/doc/circleFeature.rst b/src/SketchPlugin/doc/circleFeature.rst index 8752d00a6..1db829331 100644 --- a/src/SketchPlugin/doc/circleFeature.rst +++ b/src/SketchPlugin/doc/circleFeature.rst @@ -1,3 +1,4 @@ +.. |circle.icon| image:: images/circle.png Circle ====== @@ -7,13 +8,7 @@ The feature Circle creates a circle in the current Sketch. To add a new Circle to the Sketch: #. select in the Main Menu *Sketch - > Circle* item or -#. click **Circle** button in Sketch toolbar: - -.. image:: images/circle.png - :align: center - -.. centered:: - **Circle** button +#. click |circle.icon| **Circle** button in Sketch toolbar: There are 2 algorithms for creation of a Circle: @@ -37,9 +32,15 @@ Click in the view once to set the center point, then move the mouse and click a - When entering a passing point by selecting a point, a Coincident constraint is also created. - When entering a passing point by selecting a segment, a Tangent constraint is created. -**TUI Command**: *Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY)* +**TUI Command**: + +.. py:function:: Sketch_1.addCircle(CenterX, CenterY, PassedX, PassedY) -**Arguments**: 4 values (coordinates of the center and the passed point). + :param real: Start X. + :param real: Start Y. + :param real: Passed X. + :param real: Passed Y. + :return: Result object. By three points """"""""""""""" @@ -53,9 +54,17 @@ and finally move the mouse and click a third time to set the last passed point. - When entering a passing point by selecting a point, a Coincident constraint is created. - When entering a passing point by selecting a segment, a Tangent constraint is created. -**TUI Command**: *Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3)* +**TUI Command**: + +.. py:function:: Sketch_1.addCircle(X1, Y1, X2, Y2, X3, Y3) -**Arguments**: 6 values (coordinates of three points). + :param real: Start X. + :param real: Start Y. + :param real: Passed X. + :param real: Passed Y. + :param real: End X. + :param real: End Y. + :return: Result object. Property panel in edition context """""""""""""""""""""""""""""""""