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 .. image:: images/cylinder_32x32.png
  16    :align: left
  17    :height: 24px
  18
  19 **Cylinder** creates a cylinder.
  20
  21 .. image:: 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 .. image:: images/Cylinder.png
  33    :align: center
  34
  35 .. centered::
  36    **Cylinder** property panel
  37
  38 Input fields:
  39
  40 - **Point** defines the center of the cylinder base selected in 3D OCC  viewer or object browser;
  41 - **Vector** defines the axis of the cylinder selected in 3D OCC  viewer or object browser;
  42 - Dimensions:
  43    - **Radius**;
  44    - **Height**.
  45
  46 **TUI Commands**:
  47
  48 .. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height)
  49
  50     :param part: The current part object.
  51     :param object: Vertex.
  52     :param object: Axis.
  53     :param real: Radius.
  54     :param real: Height.
  55     :return: Result object.
  56
  57 Result
  58 """"""
  59
  60 An example is shown below.
  61
  62 .. image:: images/Cylinder1.png
  63            :align: center
  64
  65 .. centered::
  66    Cylinder
  67
  68 **See Also** a sample TUI Script of :ref:`tui_create_cylinder` operation.
  69
  70 Portion of cylinder
  71 -------------------
  72
  73 .. image:: images/Portion_cylinder.png
  74            :align: center
  75
  76 .. centered::
  77    **Portion of cylinder**  property panel
  78
  79 Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder.
  80
  81 **TUI Commands**:
  82
  83 .. py:function:: model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)
  84
  85     :param part: The current part object.
  86     :param object: Vertex.
  87     :param object: Axis.
  88     :param real: Radius.
  89     :param real: Height.
  90     :param real: Angle.
  91     :return: Result object.
  92
  93 Result
  94 """"""
  95
  96 An example is shown below.
  97
  98 .. image:: images/Cylinder2.png
  99            :align: center
 100
 101 .. centered::
 102    Portion of cylinder
 103
 104 **See Also** a sample TUI Script of :ref:`tui_create_cylportion` operation.