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