Salome HOME
Issue #3086: Avoid crash when FeatureInfo is null.
[modules/shaper.git] / src / PrimitivesPlugin / doc / torusFeature.rst
index 6b5be953a1b51324835e6ae4687b8db0eca9a6a2..31f59fc6ad38f7df462a0ad56d0c1fb630ededb5 100644 (file)
@@ -1,10 +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::
-  Create a torus
+   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.
+