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 two 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
  32 By angles
  33 --------
  34
  35 .. image:: images/RevolutionFuse1.png
  36   :align: center
  37
  38 .. centered::
  39   Revolution Fuse: 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 - **Fuse with** contains a list of objects which will be fused with the result of revolution.
  46
  47 **TUI Command**:
  48
  49 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, angle, objectToFuse)
  50
  51     :param part: The current part object.
  52     :param list: A list of objects for revolution.
  53     :param object: An axis.
  54     :param real: Angle.
  55     :param list: A list of objects to fuse with.
  56     :return: Created object.
  57
  58 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toAngle, fromAngle, objectToFuse)
  59
  60     :param part: The current part object.
  61     :param list: A list of objects for revolution.
  62     :param object: An axis.
  63     :param real: To angle.
  64     :param real: From angle.
  65     :param list: A list of objects to fuse with.
  66     :return: Created object.
  67
  68 Result
  69 """"""
  70
  71 The Result of the operation will be a revolved shape:
  72
  73 .. image:: images/revolution_fuse_by_angles_result.png
  74            :align: center
  75
  76 .. centered::
  77    **Revolution Fuse created**
  78
  79 **See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_angles` operation.
  80
  81 By bounding planes
  82 ------------------
  83
  84 .. image:: images/RevolutionFuse2.png
  85   :align: center
  86
  87 .. centered::
  88   Revolution Fuse: 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 - **Fuse with** - contains a list of objects which will be fused with the result of revolution.
  97
  98 **TUI Command**:
  99
 100 .. py:function:: model.addRevolutionFuse(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToFuse)
 101
 102     :param part: The current part object.
 103     :param list: A list of objects for revolution.
 104     :param object: An axis.
 105     :param object: To object.
 106     :param real: To offset.
 107     :param object: From object.
 108     :param real: From offset.
 109     :param list: A list of objects to fuse with.
 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_fuse_by_bounding_planes_result.png
 118            :align: center
 119
 120 .. centered::
 121    **Revolution Fuse created**
 122
 123 **See Also** a sample TUI Script of :ref:`tui_create_revolution_fuse_by_bounding_planes` operation.