X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FPrimitivesPlugin%2Fdoc%2FtorusFeature.rst;h=31f59fc6ad38f7df462a0ad56d0c1fb630ededb5;hb=c6745a6b1ad00c0285fab5aeac2cb0d57afef5cc;hp=c4cfca39e38712ec79b52e96f0b3f1617add22b9;hpb=c5ec43297b55923e1cf2ee39978bf42d733ee465;p=modules%2Fshaper.git diff --git a/src/PrimitivesPlugin/doc/torusFeature.rst b/src/PrimitivesPlugin/doc/torusFeature.rst index c4cfca39e..31f59fc6a 100644 --- a/src/PrimitivesPlugin/doc/torusFeature.rst +++ b/src/PrimitivesPlugin/doc/torusFeature.rst @@ -1,3 +1,52 @@ +.. |Torus_button.icon| image:: images/Torus_button.png Torus ===== + +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.icon| **Torus** button in the toolbar + +The following property panel appears. + +.. image:: images/Torus.png + :align: center + +.. centered:: + Torus + +Input fields: + +- **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**: + +.. py:function:: model.addTorus(Part_doc, Point, Axis, Radius1, Radius2) + + :param part: The current part object. + :param object: Vertex. + :param object: Axis. + :param real: Radius 1. + :param real: Radius 2. + :return: Result object. + +Result +"""""" + +An example is shown below. + +.. image:: images/Torus_res.png + :align: center + +.. centered:: + Torus created + +**See Also** a sample TUI Script of :ref:`tui_create_torus` operation. +