src/FeaturesPlugin/doc/revolutionFuseFeature.rst

   1 .. |revolution_fuse_btn.icon|    image:: images/revolution_fuse_btn.png
   2
   3 Revolution Fuse
   4 ===============
   5
   6 Revolution Fuse feature revolves the selected objects around the selected axis and fuses the result with other objects.
   7
   8 To perform Revolution Fuse in the active part:
   9
  10 #. select in the Main Menu *Features - > Revolution Fuse* item  or
  11 #. click |revolution_fuse_btn.icon| **Revolution Fuse** 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 three variants of the property panel for Revolution Fuse 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 .. image:: images/revolution_through_all.png
  32    :align: left
  33 **Through All** revolves objects by 360 degrees.
  34
  35
  36 By angles
  37 --------
  38
  39 .. image:: images/RevolutionFuse1.png
  40   :align: center
  41
  42 .. centered::
  43   Revolution Fuse: definition by angles
  44
  45 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  46 - **Axis** - axis of revolution.
  47 - **To angle** - end angle of revolution.
  48 - **From angle**-  start angle of revolution.
  49 - **Fuse with** contains a list of objects which will be fused with the result of revolution.
  50
  51 **TUI Command**:
  52
  53 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse)
  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: Angle.
  59     :param list: A list of objects to fuse with.
  60     :return: Created object.
  61
  62 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse)
  63
  64     :param part: The current part object.
  65     :param list: A list of objects for revolution.
  66     :param object: An axis.
  67     :param real: To angle.
  68     :param real: From angle.
  69     :param list: A list of objects to fuse with.
  70     :return: Created object.
  71
  72 Result
  73 """"""
  74
  75 The Result of the operation will be a revolved shape:
  76
  77 .. image:: images/revolution_fuse_by_angles_result.png
  78            :align: center
  79
  80 .. centered::
  81    **Revolution Fuse created**
  82
  83 **See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_angles` operation.
  84
  85 By bounding planes
  86 ------------------
  87
  88 .. image:: images/RevolutionFuse2.png
  89   :align: center
  90
  91 .. centered::
  92   Revolution Fuse: definition by bounding planes
  93
  94 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  95 - **Axis** - axis of revolution.
  96 - **To plane** - a planar face can be selected to bound revolution from one side.
  97 - **To offset** - offset for revolution or for bounding plane, if selected.
  98 - **From plane** - a planar face can be selected to bound revolution from other side.
  99 - **From offset** - offset for revolution or for bounding plane, if selected.
 100 - **Fuse with** - contains a list of objects which will be fused with the result of revolution.
 101
 102 **TUI Command**:
 103
 104 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToFuse)
 105
 106     :param part: The current part object.
 107     :param list: A list of objects for revolution.
 108     :param object: An axis.
 109     :param object: To object.
 110     :param real: To offset.
 111     :param object: From object.
 112     :param real: From offset.
 113     :param list: A list of objects to fuse with.
 114     :return: Created object.
 115
 116 Result
 117 """"""
 118
 119 The Result of the operation will be a revolved shape:
 120
 121 .. image:: images/revolution_fuse_by_bounding_planes_result.png
 122            :align: center
 123
 124 .. centered::
 125    **Revolution Fuse created**
 126
 127 **See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_bounding_planes` operation.
 128
 129 Through All
 130 -----------
 131
 132 .. image:: images/RevolutionFuse3.png
 133   :align: center
 134
 135 .. centered::
 136   Revolution Fuse: definition by bounding planes
 137
 138 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
 139 - **Axis** - axis of revolution.
 140 - **Fuse with** - contains a list of objects which will be fused with the result of revolution.
 141
 142 **TUI Command**:
 143
 144 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, objectToFuse)
 145
 146     :param part: The current part object.
 147     :param list: A list of objects for revolution.
 148     :param object: An axis.
 149     :param list: A list of objects to fuse with.
 150     :return: Created object.
 151
 152 Result
 153 """"""
 154
 155 The Result of the operation will be a revolved shape:
 156
 157 .. image:: images/revolution_fuse_through_all_result.png
 158            :align: center
 159
 160 .. centered::
 161    **Revolution Fuse created**
 162
 163 **See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_through_all` operation.