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 .. image:: images/Torus.png
  16   :align: center
  17
  18 .. centered::
  19    Torus
  20
  21 Input fields:
  22
  23 - **Point** defines the center of the torus base selected in 3D OCC  viewer or object browser;
  24 - **Vector** defines the axis of the torus selected in 3D OCC  viewer or object browser;
  25 - Dimensions:
  26    - **Radius**;
  27    - **Ring radius**.
  28
  29 **TUI Command**:
  30
  31 .. py:function:: model.addTorus(Part_doc, Point, Axis, Radius1, Radius2)
  32
  33     :param part: The current part object.
  34     :param object: Vertex.
  35     :param object: Axis.
  36     :param real: Radius 1.
  37     :param real: Radius 2.
  38     :return: Result object.
  39
  40 Result
  41 """"""
  42
  43 An example is shown below.
  44
  45 .. image:: images/Torus_res.png
  46            :align: center
  47
  48 .. centered::
  49    Torus created
  50
  51 **See Also** a sample TUI Script of :ref:`tui_create_torus` operation.
  52