src/FeaturesPlugin/doc/revolutionFeature.rst

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