src/PrimitivesPlugin/doc/tubeFeature.rst

   1 .. |Tube_button.icon|    image:: images/Tube_button.png
   2
   3 Tube
   4 ====
   5
   6 Tube feature creates a tube solid.
   7
   8 To create a Tube in the active part:
   9
  10 #. select in the Main Menu *Primitives - > Tube* item  or
  11 #. click |Tube_button.icon| **Tube** button in the toolbar
  12
  13 The following property panel appears.
  14
  15 .. figure:: images/Tube.png
  16    :align: center
  17
  18    Tube
  19
  20 Input fields:
  21
  22 - **rmin** defines the inner radius of the the tube;
  23 - **rmax** defines the outer radius of the the tube;
  24 - **height** defines the height of the the tube;
  25
  26 **TUI Command**:
  27
  28 .. py:function:: model.addTube(Part_doc, rmin, rmax, height)
  29
  30     :param part: The current part object.
  31     :param real: rmin.
  32     :param real: rmax.
  33     :param real: height.
  34     :return: Result object.
  35
  36 Result
  37 """"""
  38
  39 An example is shown below.
  40
  41 .. figure:: images/Tube_res.png
  42    :align: center
  43
  44    Tube created
  45
  46 **See Also** a sample TUI Script of :ref:`tui_create_tube` operation.