src/PrimitivesPlugin/doc/cylinderFeature.rst

   1
   2 Cylinder
   3 ========
   4
   5 Cylinder feature creates a cylinder solid.
   6
   7 To create a Cylinder in the active part:
   8
   9 #. select in the Main Menu *Primitives - > Cylinder* item  or
  10 #. click **Cylinder** button in the toolbar
  11
  12 .. image:: images/Cylinder_button.png
  13    :align: center
  14
  15 .. centered::
  16    **Cylinder** button
  17
  18 There are 2 algorithms for creation of a Cylinder:
  19
  20 .. image:: images/cylinder_32x32.png
  21    :align: left
  22 **Cylinder** creates a cylinder.
  23
  24 .. image:: images/cylinder_portion_32x32.png
  25    :align: left
  26 **Portion of cylinder** creates one segment of a cylinder.
  27
  28 Cylinder
  29 --------
  30
  31 .. image:: images/Cylinder.png
  32    :align: center
  33
  34 .. centered::
  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**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height)*
  46
  47 **Arguments**:   Part + 1 vertex +1 vector +  2 real values (radius, height).
  48
  49 Result
  50 """"""
  51
  52 An example is shown below.
  53
  54 .. image:: images/Cylinder1.png
  55            :align: center
  56
  57 .. centered::
  58    Cylinder
  59
  60 **See Also** a sample TUI Script of :ref:`tui_create_cylinder` operation.
  61
  62 Portion of cylinder
  63 -------------------
  64
  65 .. image:: images/Portion_cylinder.png
  66            :align: center
  67
  68 .. centered::
  69    **Portion of cylinder**  property panel
  70
  71 Input fields for ***Portion of cylinder** tab include **Angle** defining a portion of cylinder.
  72
  73 **TUI Commands**: *model.addCylinder(Part_doc, Point, Axis, Radius, Height,Angle)*
  74
  75 **Arguments**:   1 Part + 1 vertex +1 vector +  3 real values (radius, height and angle).
  76
  77 Result
  78 """"""
  79
  80 An example is shown below.
  81
  82 .. image:: images/Cylinder2.png
  83            :align: center
  84
  85 .. centered::
  86    Portion of cylinder
  87
  88 **See Also** a sample TUI Script of :ref:`tui_create_cylportion` operation.