src/PrimitivesPlugin/doc/cylinderFeature.rst

   1 .. |Cylinder_button.icon|    image:: images/Cylinder_button.png
   2
   3 Cylinder
   4 ========
   5
   6 Cylinder feature creates a cylinder solid.
   7
   8 To create a Cylinder in the active part:
   9
  10 #. select in the Main Menu *Primitives - > Cylinder* item  or
  11 #. click |Cylinder_button.icon| **Cylinder** button in the toolbar
  12
  13 There are 2 algorithms for creation of a Cylinder:
  14
  15 .. figure:: images/cylinder_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 **Cylinder** creates a cylinder.
  20
  21 .. figure:: images/cylinder_portion_32x32.png
  22    :align: left
  23    :height: 24px
  24
  25 **Portion of cylinder** creates one segment of a cylinder.
  26
  27 --------------------------------------------------------------------------------
  28
  29 Cylinder
  30 --------
  31
  32 .. figure:: images/Cylinder.png
  33    :align: center
  34
  35    **Cylinder** property panel
  36
  37 Input fields:
  38
  39 - **Point** defines the center of the cylinder base selected in 3D OCC  viewer or object browser;
  40 - **Vector** defines the axis of the cylinder selected in 3D OCC  viewer or object browser;
  41 - Dimensions:
  42    - **Radius**;
  43    - **Height**.
  44
  45 **TUI Commands**:
  46
  47 .. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height)
  48
  49     :param part: The current part object.
  50     :param object: Vertex.
  51     :param object: Axis.
  52     :param real: Radius.
  53     :param real: Height.
  54     :return: Result object.
  55
  56 Result
  57 """"""
  58
  59 An example is shown below.
  60
  61 .. figure:: images/Cylinder1.png
  62    :align: center
  63
  64    Cylinder
  65
  66 **See Also** a sample TUI Script of :ref:`tui_create_cylinder` operation.
  67
  68 Portion of cylinder
  69 -------------------
  70
  71 .. figure:: images/Portion_cylinder.png
  72    :align: center
  73
  74    **Portion of cylinder**  property panel
  75
  76 Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder.
  77
  78 **TUI Commands**:
  79
  80 .. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)
  81
  82     :param part: The current part object.
  83     :param object: Vertex.
  84     :param object: Axis.
  85     :param real: Radius.
  86     :param real: Height.
  87     :param real: Angle.
  88     :return: Result object.
  89
  90 Result
  91 """"""
  92
  93 An example is shown below.
  94
  95 .. figure:: images/Cylinder2.png
  96    :align: center
  97
  98    Portion of cylinder
  99
 100 **See Also** a sample TUI Script of :ref:`tui_create_cylportion` operation.