src/FeaturesPlugin/doc/revolutionCutFeature.rst

   1
   2 Revolution Cut
   3 ==============
   4
   5 Revolution Cut feature revolves the selected objects around the selected axis and cuts the result from other objects.
   6
   7 To perform a Revolution Cut in the active part:
   8
   9 #. select in the Main Menu *Features - > Revolution Cut* item  or
  10 #. click **Revolution Cut** button in the toolbar
  11
  12 .. image:: images/revolution_cut_btn.png
  13    :align: center
  14
  15 .. centered::
  16    **Revolution Cut** button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/StartSketch.png
  21   :align: center
  22
  23 .. centered::
  24   Start sketch
  25
  26 There are two variants of the property panel for Revolution Cut depending on the chosen option:
  27
  28 .. image:: images/revolution_by_angles.png
  29    :align: left
  30 **By Angles** revolves objects by specifying angles.
  31
  32 .. image:: images/revolution_by_bounding_planes.png
  33    :align: left
  34 **By Bounding Planes** revolves objects by specifying bounding planes and angles.
  35
  36
  37 By angles
  38 --------
  39
  40 .. image:: images/RevolutionCut1.png
  41   :align: center
  42
  43 .. centered::
  44   Revolution Cut: definition by angles
  45
  46 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  47 - **Axis** - axis of revolution.
  48 - **To angle** - end angle of revolution.
  49 - **From angle** - start angle of revolution.
  50 - **Cut from** - contains a list of objects which will but cut with the result of revolution.
  51
  52 **TUI Command**:  *model.addRevolutionCut(part, objectsToRevolve, axis, angle, objectToCut);*
  53
  54 **Arguments**:   Part + list of objects for revolution + axis + angle + list of objects to cut from.
  55
  56 **TUI Command**:  *model.addRevolutionCut(part, objectsToRevolve, axis, toAngle, fromAngle, objectToCut);*
  57
  58 **Arguments**:   Part + list of objects for revolution + axis + to angle + from angle + list of objects to cut from.
  59
  60 Result
  61 """"""
  62
  63 The Result of the operation will be a revolved shape:
  64
  65 .. image:: images/revolution_cut_by_angles_result.png
  66            :align: center
  67
  68 .. centered::
  69    **Revolution Cut created**
  70
  71 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_angles` operation.
  72
  73 By bounding planes
  74 ------------------
  75
  76 .. image:: images/RevolutionCut2.png
  77   :align: center
  78
  79 .. centered::
  80   Revolution Cut: definition by bounding planes
  81
  82 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be revolved.
  83 - **Axis** - axis of revolution.
  84 - **To plane** - a planar face can be selected to bound revolution from one side.
  85 - **To offset** - offset for revolution or for bounding plane, if selected.
  86 - **From plane** - a planar face can be selected to bound revolution from the other side.
  87 - **From offset** - offset for revolution or for bounding plane, if selected.
  88 - **Cut from** - contains a list of objects from which the result of revolution will be cut.
  89
  90 **TUI Command**:  *model.addRevolutionCut(part, objectsToRevolve, axis, toObject, toOffset, fromObject, fromOffset, objectToCut);*
  91
  92 **Arguments**:   Part + list of objects for revolution + axis + to object + to offset + from object + from offset + list of objects to cut from.
  93
  94 Result
  95 """"""
  96
  97 The Result of the operation will be a revolved shape:
  98
  99 .. image:: images/revolution_cut_by_bounding_planes_result.png
 100            :align: center
 101
 102 .. centered::
 103    **Revolution Cut created**
 104
 105 **See Also** a sample TUI Script of :ref:`tui_create_revolution_cut_by_bounding_planes` operation.