X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPrimitivesPlugin%2Fdoc%2FtorusFeature.rst;h=31f59fc6ad38f7df462a0ad56d0c1fb630ededb5;hb=c6745a6b1ad00c0285fab5aeac2cb0d57afef5cc;hp=9d3e02242fc125bd4abfde3eaf7762b176fbb0b5;hpb=db1f629785c83f9691b1707b3fd11a26625c7a26;p=modules%2Fshaper.git diff --git a/src/PrimitivesPlugin/doc/torusFeature.rst b/src/PrimitivesPlugin/doc/torusFeature.rst index 9d3e02242..31f59fc6a 100644 --- a/src/PrimitivesPlugin/doc/torusFeature.rst +++ b/src/PrimitivesPlugin/doc/torusFeature.rst @@ -1,19 +1,14 @@ +.. |Torus_button.icon| image:: images/Torus_button.png Torus ===== -The feature Torus creates a torus solid. +Torus feature creates a torus solid. To create a Torus in the active part: #. select in the Main Menu *Primitives - > Torus* item or -#. click **Torus** button in the toolbar - -.. image:: images/Torus_button.png - :align: center - -.. centered:: - **Torus** button +#. click |Torus_button.icon| **Torus** button in the toolbar The following property panel appears. @@ -25,20 +20,27 @@ The following property panel appears. Input fields: -- **Point** defines center of the torus base selected in 3D OCC viewer or object browser; +- **Point** defines the center of the torus base selected in 3D OCC viewer or object browser; - **Vector** defines the axis of the torus selected in 3D OCC viewer or object browser; - Dimensions: - **Radius**; - **Ring radius**. -**TUI Command**: *model.addTorus(Part_doc, Point, Axis, Radius1, Radius2)* +**TUI Command**: + +.. py:function:: model.addTorus(Part_doc, Point, Axis, Radius1, Radius2) -**Arguments**: Part + 1 vertex + 1 vector + 2 real values (first and second radii). + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius 1. + :param real: Radius 2. + :return: Result object. Result """""" -Example is shown below. +An example is shown below. .. image:: images/Torus_res.png :align: center @@ -46,5 +48,5 @@ Example is shown below. .. centered:: Torus created -**See Also** a sample TUI Script of a :ref:`tui_create_torus` operation. +**See Also** a sample TUI Script of :ref:`tui_create_torus` operation.