src/PrimitivesPlugin/doc/torusFeature.rst

   1 .. |Torus_button.icon|    image:: images/Torus_button.png
   2
   3 Torus
   4 =====
   5
   6 Torus feature creates a torus solid.
   7
   8 To create a Torus in the active part:
   9
  10 #. select in the Main Menu *Primitives - > Torus* item  or
  11 #. click |Torus_button.icon| **Torus** button in the toolbar
  12
  13 The following property panel appears.
  14
  15 .. figure:: images/Torus.png
  16    :align: center
  17
  18    Torus
  19
  20 Input fields:
  21
  22 - **Point** defines the center of the torus base selected in 3D OCC  viewer or object browser;
  23 - **Vector** defines the axis of the torus selected in 3D OCC  viewer or object browser;
  24 - Dimensions:
  25    - **Radius**;
  26    - **Ring radius**.
  27
  28 **TUI Command**:
  29
  30 .. py:function:: model.addTorus(Part_doc, Point, Axis, Radius1, Radius2)
  31
  32     :param part: The current part object.
  33     :param object: Vertex.
  34     :param object: Axis.
  35     :param real: Radius 1.
  36     :param real: Radius 2.
  37     :return: Result object.
  38
  39 Result
  40 """"""
  41
  42 An example is shown below.
  43
  44 .. figure:: images/Torus_res.png
  45    :align: center
  46
  47    Torus created
  48
  49 **See Also** a sample TUI Script of :ref:`tui_create_torus` operation.
  50