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 .. 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 Cut 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 .. image:: images/revolution_through_all.png
  36    :align: left
  37    :height: 24px
  38
  39 **Through All** revolves objects by 360 degrees.
  40
  41 --------------------------------------------------------------------------------
  42
  43 By angles
  44 ---------
  45
  46 .. image:: images/RevolutionCut1.png
  47   :align: center
  48
  49 .. centered::
  50   Revolution Cut: definition by angles
  51
  52 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  53 - **Axis** - axis of revolution.
  54 - **To angle** - end angle of revolution.
  55 - **From angle** - start angle of revolution.
  56 - **Cut from** - contains a list of objects which will but cut with the result of revolution.
  57
  58 **TUI Commands**:
  59
  60 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, angle, objectToCut)
  61
  62     :param part: The current part object.
  63     :param list: A list of objects for revolution.
  64     :param object: An axis.
  65     :param real: An angle.
  66     :param list: A list of objects to cut from.
  67     :return: Created object.
  68
  69 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, toAngle, fromAngle, objectToCut)
  70
  71     :param part: The current part object.
  72     :param list: A list of objects for revolution.
  73     :param object: An axis.
  74     :param real: To angle.
  75     :param real: From angle.
  76     :param list: A list of objects to cut from.
  77     :return: Created object.
  78
  79 Result
  80 """"""
  81
  82 The Result of the operation will be a revolved shape:
  83
  84 .. image:: images/revolution_cut_by_angles_result.png
  85            :align: center
  86
  87 .. centered::
  88    **Revolution Cut created**
  89
  90 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_angles` operation.
  91
  92 By bounding planes
  93 ------------------
  94
  95 .. image:: images/RevolutionCut2.png
  96   :align: center
  97
  98 .. centered::
  99   Revolution Cut: definition by bounding planes
 100
 101 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
 102 - **Axis** - axis of revolution.
 103 - **To plane** - a planar face can be selected to bound revolution from one side.
 104 - **To offset** - offset for revolution or for bounding plane, if selected.
 105 - **From plane** - a planar face can be selected to bound revolution from the other side.
 106 - **From offset** - offset for revolution or for bounding plane, if selected.
 107 - **Cut from** - contains a list of objects from which the result of revolution will be cut.
 108
 109 **TUI Command**:
 110
 111 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToCut)
 112
 113     :param part: The current part object.
 114     :param list: A list of objects for revolution.
 115     :param object: An axis.
 116     :param object: To object.
 117     :param real: To offset.
 118     :param object: From object.
 119     :param real: From offset.
 120     :param list: A list of objects to cut from.
 121     :return: Created object.
 122
 123 Result
 124 """"""
 125
 126 The Result of the operation will be a revolved shape:
 127
 128 .. image:: images/revolution_cut_by_bounding_planes_result.png
 129            :align: center
 130
 131 .. centered::
 132    **Revolution Cut created**
 133
 134 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_bounding_planes` operation.
 135
 136 Through all
 137 -----------
 138
 139 .. image:: images/RevolutionCut3.png
 140   :align: center
 141
 142 .. centered::
 143   Revolution Cut: revolving through all the space
 144
 145 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
 146 - **Axis** - axis of revolution.
 147 - **Cut from** - contains a list of objects which will but cut with the result of revolution.
 148
 149 **TUI Commands**:
 150
 151 .. py:function:: model.addRevolutionCut(part, objectsToRevolve, axis, objectToCut)
 152
 153     :param part: The current part object.
 154     :param list: A list of objects for revolution.
 155     :param object: An axis.
 156     :param list: A list of objects to cut from.
 157     :return: Created object.
 158
 159 Result
 160 """"""
 161
 162 The Result of the operation will be a revolved shape:
 163
 164 .. image:: images/revolution_cut_through_all_result.png
 165            :align: center
 166
 167 .. centered::
 168    **Revolution Cut created**
 169
 170 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_through_all` operation.