X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FFeaturesPlugin%2Fdoc%2FrevolutionFeature.rst;h=cdf8790e347f8efa829bd87429b749ed1b80e851;hb=0fcd69345a4dfdb31e252574c68bc70e123999e8;hp=eb492261cdd11f0ce9c509a6301bb34af7a61b9f;hpb=b7ec3c27f028060b3c42b7da6fa3dfe962fe26e4;p=modules%2Fshaper.git diff --git a/src/FeaturesPlugin/doc/revolutionFeature.rst b/src/FeaturesPlugin/doc/revolutionFeature.rst index eb492261c..cdf8790e3 100644 --- a/src/FeaturesPlugin/doc/revolutionFeature.rst +++ b/src/FeaturesPlugin/doc/revolutionFeature.rst @@ -1,3 +1,4 @@ +.. |revolution_btn.icon| image:: images/revolution_btn.png Revolution ========== @@ -7,13 +8,7 @@ Revolution feature revolves selected objects around selected axis. To perform a Revolution in the active part: #. select in the Main Menu *Features - > Revolution* item or -#. click **Revolution** button in the toolbar - -.. image:: images/revolution_btn.png - :align: center - -.. centered:: - **Revolution** button +#. click |revolution_btn.icon| **Revolution** button in the toolbar The following property panel will be opened: @@ -48,13 +43,24 @@ By angles - **To angle** - end angle of revolution. - **From angle** - start angle of revolution. -**TUI Command**: *model.addRevolution(part, objects, axis, angle);* +**TUI Commands**: -**Arguments**: Part + list of objects + axis + angle. +.. py:function:: model.addRevolution(part, objects, axis, angle) -**TUI Command**: *model.addRevolution(part, objects, axis, toSize, fromSize);* + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: An angle. + :return: Created object. -**Arguments**: Part + list of objects + axis + to angle + from angle. +.. py:function:: model.addRevolution(part, objects, axis, toSize, fromSize) + + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param real: To angle. + :param real: From angle. + :return: Created object. Result """""" @@ -85,9 +91,18 @@ By bounding planes - **From plane** - a planar face can be selected to bound revolution from other side. - **From offset** - offset for revolution or for bounding plane, if selected. -**TUI Command**: *model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset);* +**TUI Command**: + +.. py:function:: model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset) -**Arguments**: Part + list of objects + axis + to object + to offset + from object + from offset. + :param part: The current part object. + :param list: A list of objects for revolution. + :param object: An axis. + :param object: To object. + :param real: To offset. + :param object: From object. + :param real: From offset. + :return: Created object. Result """"""