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 **By Angles** revolves objects by specifying angles.
  26
  27 .. image:: images/revolution_by_bounding_planes.png
  28    :align: left
  29 **By Bounding Planes** revolves objects by specifying bounding planes and angles.
  30
  31
  32 By angles
  33 --------
  34
  35 .. image:: images/Revolution1.png
  36   :align: center
  37
  38 .. centered::
  39   Revolution: definition by angles
  40
  41 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  42 - **Axis** - axis of revolution.
  43 - **To angle** - end angle of revolution.
  44 - **From angle** - start angle of revolution.
  45
  46 **TUI Commands**:
  47
  48 .. py:function:: model.addRevolution(part, objects, axis, angle)
  49
  50     :param part: The current part object.
  51     :param list: A list of objects for revolution.
  52     :param object: An axis.
  53     :param real: An angle.
  54     :return: Created object.
  55
  56 .. py:function:: model.addRevolution(part, objects, axis, toSize, fromSize)
  57
  58     :param part: The current part object.
  59     :param list: A list of objects for revolution.
  60     :param object: An axis.
  61     :param real: To angle.
  62     :param real: From angle.
  63     :return: Created object.
  64
  65 Result
  66 """"""
  67
  68 The Result of the operation will be a revolved shape:
  69
  70 .. image:: images/revolution_by_angles_result.png
  71            :align: center
  72
  73 .. centered::
  74    **Revolution created**
  75
  76 **See Also** a sample TUI Script of :ref:`tui_create_revolution_by_angles` operation.
  77
  78 By bounding planes
  79 ------------------
  80
  81 .. image:: images/Revolution2.png
  82   :align: center
  83
  84 .. centered::
  85   Revolution: definition by bounding planes
  86
  87 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  88 - **Axis** - axis of revolution.
  89 - **To plane**  - a planar face can be selected to bound revolution from one side.
  90 - **To offset** - offset for revolution or for bounding plane, if selected.
  91 - **From plane** - a planar face can be selected to bound revolution from other side.
  92 - **From offset** - offset for revolution or for bounding plane, if selected.
  93
  94 **TUI Command**:
  95
  96 .. py:function:: model.addRevolution(part, objects, axis, toObject, toOffset, fromObject, fromOffset)
  97
  98     :param part: The current part object.
  99     :param list: A list of objects for revolution.
 100     :param object: An axis.
 101     :param object: To object.
 102     :param real: To offset.
 103     :param object: From object.
 104     :param real: From offset.
 105     :return: Created object.
 106
 107 Result
 108 """"""
 109
 110 The Result of the operation will be a revolved shape:
 111
 112 .. image:: images/revolution_by_bounding_planes_result.png
 113            :align: center
 114
 115 .. centered::
 116    **Revolution created**
 117
 118 **See Also** a sample TUI Script of :ref:`tui_create_revolution_by_bounding_planes` operation.