src/FeaturesPlugin/doc/revolutionFeature.rst

   1
   2 Revolution
   3 ==========
   4
   5 Revolution feature revolves selected objects around selected axis.
   6
   7 To perform a Revolution in the active part:
   8
   9 #. select in the Main Menu *Features - > Revolution* item  or
  10 #. click **Revolution** button in the toolbar
  11
  12 .. image:: images/revolution_btn.png
  13    :align: center
  14
  15 .. centered::
  16    **Revolution** button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/StartSketch.png
  21   :align: center
  22
  23 .. centered::
  24   Start sketch
  25
  26 There are two variants of the property panel for Revolution depending on the chosen option:
  27
  28 .. image:: images/revolution_by_angles.png
  29    :align: left
  30 **By Angles** revolves objects by specifying angles.
  31
  32 .. image:: images/revolution_by_bounding_planes.png
  33    :align: left
  34 **By Bounding Planes** revolves objects by specifying bounding planes and angles.
  35
  36
  37 By angles
  38 --------
  39
  40 .. image:: images/Revolution1.png
  41   :align: center
  42
  43 .. centered::
  44   Revolution: definition by angles
  45
  46 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  47 - **Axis** - axis of revolution.
  48 - **To angle** - end angle of revolution.
  49 - **From angle** - start angle of revolution.
  50
  51 **TUI Command**:  *model.addRevolution(part, objects, axis, angle);*
  52
  53 **Arguments**:   Part + list of objects + axis + angle.
  54
  55 **TUI Command**:  *model.addRevolution(part, objects, axis, toSize, fromSize);*
  56
  57 **Arguments**:   Part + list of objects + axis + to angle + from angle.
  58
  59 Result
  60 """"""
  61
  62 The Result of the operation will be a revolved shape:
  63
  64 .. image:: images/revolution_by_angles_result.png
  65            :align: center
  66
  67 .. centered::
  68    **Revolution created**
  69
  70 **See Also** a sample TUI Script of :ref:`tui_create_revolution_by_angles` operation.
  71
  72 By bounding planes
  73 ------------------
  74
  75 .. image:: images/Revolution2.png
  76   :align: center
  77
  78 .. centered::
  79   Revolution: definition by bounding planes
  80
  81 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  82 - **Axis** - axis of revolution.
  83 - **To plane**  - a planar face can be selected to bound revolution from one side.
  84 - **To offset** - offset for revolution or for bounding plane, if selected.
  85 - **From plane** - a planar face can be selected to bound revolution from other side.
  86 - **From offset** - offset for revolution or for bounding plane, if selected.
  87
  88 **TUI Command**:  *model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset);*
  89
  90 **Arguments**:   Part + list of objects + axis + to object + to offset + from object + from offset.
  91
  92 Result
  93 """"""
  94
  95 The Result of the operation will be a revolved shape:
  96
  97 .. image:: images/revolution_by_bounding_planes_result.png
  98            :align: center
  99
 100 .. centered::
 101    **Revolution created**
 102
 103 **See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation.