src/FeaturesPlugin/doc/revolutionFeature.rst

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