src/PrimitivesPlugin/doc/torusFeature.rst

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