src/FeaturesPlugin/doc/revolutionCutFeature.rst

   1 .. |revolution_cut_btn.icon|    image:: images/revolution_cut_btn.png
   2
   3 Revolution Cut
   4 ==============
   5
   6 Revolution Cut feature revolves the selected objects around the selected axis and cuts the result from other objects.
   7
   8 To perform a Revolution Cut in the active part:
   9
  10 #. select in the Main Menu *Features - > Revolution Cut* item  or
  11 #. click |revolution_cut_btn.icon| **Revolution Cut** button in the toolbar
  12
  13 The following property panel will be opened:
  14
  15 .. figure:: images/StartSketch.png
  16    :align: center
  17
  18    Start sketch
  19
  20 There are three variants of the property panel for Revolution Cut depending on the chosen option:
  21
  22 .. figure:: images/revolution_by_angles.png
  23    :align: left
  24    :height: 24px
  25
  26 **By Angles** revolves objects by specifying angles.
  27
  28 .. figure:: images/revolution_by_bounding_planes.png
  29    :align: left
  30    :height: 24px
  31
  32 **By Bounding Planes** revolves objects by specifying bounding planes and angles.
  33
  34 .. figure:: images/revolution_through_all.png
  35    :align: left
  36    :height: 24px
  37
  38 **Through All** revolves objects by 360 degrees.
  39
  40 --------------------------------------------------------------------------------
  41
  42 By angles
  43 ---------
  44
  45 .. figure:: images/RevolutionCut1.png
  46    :align: center
  47
  48    Revolution Cut: definition by angles
  49
  50 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  51 - **Axis** - axis of revolution.
  52 - **To angle** - end angle of revolution.
  53 - **From angle** - start angle of revolution.
  54 - **Cut from** - contains a list of objects which will but cut with the result of revolution.
  55
  56 **TUI Commands**:
  57
  58 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, angle, objectToCut)
  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: An angle.
  64     :param list: A list of objects to cut from.
  65     :return: Created object.
  66
  67 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, toAngle, fromAngle, objectToCut)
  68
  69     :param part: The current part object.
  70     :param list: A list of objects for revolution.
  71     :param object: An axis.
  72     :param real: To angle.
  73     :param real: From angle.
  74     :param list: A list of objects to cut from.
  75     :return: Created object.
  76
  77 Result
  78 """"""
  79
  80 The Result of the operation will be a revolved shape:
  81
  82 .. figure:: images/revolution_cut_by_angles_result.png
  83    :align: center
  84
  85    **Revolution Cut created**
  86
  87 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_angles` operation.
  88
  89 By bounding planes
  90 ------------------
  91
  92 .. figure:: images/RevolutionCut2.png
  93    :align: center
  94
  95    Revolution Cut: definition by bounding planes
  96
  97 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  98 - **Axis** - axis of revolution.
  99 - **To plane** - a planar face can be selected to bound revolution from one side.
 100 - **To offset** - offset for revolution or for bounding plane, if selected.
 101 - **From plane** - a planar face can be selected to bound revolution from the other side.
 102 - **From offset** - offset for revolution or for bounding plane, if selected.
 103 - **Cut from** - contains a list of objects from which the result of revolution will be cut.
 104
 105 **TUI Command**:
 106
 107 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToCut)
 108
 109     :param part: The current part object.
 110     :param list: A list of objects for revolution.
 111     :param object: An axis.
 112     :param object: To object.
 113     :param real: To offset.
 114     :param object: From object.
 115     :param real: From offset.
 116     :param list: A list of objects to cut from.
 117     :return: Created object.
 118
 119 Result
 120 """"""
 121
 122 The Result of the operation will be a revolved shape:
 123
 124 .. figure:: images/revolution_cut_by_bounding_planes_result.png
 125    :align: center
 126
 127    **Revolution Cut created**
 128
 129 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_bounding_planes` operation.
 130
 131 Through all
 132 -----------
 133
 134 .. figure:: images/RevolutionCut3.png
 135    :align: center
 136
 137    Revolution Cut: revolving through all the space
 138
 139 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
 140 - **Axis** - axis of revolution.
 141 - **Cut from** - contains a list of objects which will but cut with the result of revolution.
 142
 143 **TUI Commands**:
 144
 145 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, objectToCut)
 146
 147     :param part: The current part object.
 148     :param list: A list of objects for revolution.
 149     :param object: An axis.
 150     :param list: A list of objects to cut from.
 151     :return: Created object.
 152
 153 Result
 154 """"""
 155
 156 The Result of the operation will be a revolved shape:
 157
 158 .. figure:: images/revolution_cut_through_all_result.png
 159    :align: center
 160
 161    **Revolution Cut created**
 162
 163 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_through_all` operation.