src/FeaturesPlugin/doc/extrusionCutFeature.rst

   1 .. |extrusion_cut_btn.icon|    image:: images/extrusion_cut_btn.png
   2
   3 Extrusion Cut
   4 =============
   5
   6 Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts the result from other objects.
   7
   8 To perform Extrusion Cut in the active part:
   9
  10 #. select in the Main Menu *Features - > Extrusion Cut* item  or
  11 #. click |extrusion_cut_btn.icon| **Extrusion 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 two variants of the property panel for Extrusion Cut depending on the chosen option:
  22
  23 .. image:: images/extrusion_by_sizes.png
  24    :align: left
  25 **By Sizes** extrudes objects by specifying sizes.
  26
  27 .. image:: images/extrusion_by_bounding_planes.png
  28    :align: left
  29 **By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
  30
  31
  32 By sizes
  33 --------
  34
  35 .. image:: images/ExtrusionCut1.png
  36   :align: center
  37
  38 .. centered::
  39   Extrusion Cut: definition by sizes
  40
  41 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
  42 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
  43 - **To size**  - size for extrusion in the direction.
  44 - **From size** - size for extrusion in the opposite direction.
  45 - **Cut from** - contains a list of objects which will be cut from the result of extrusion.
  46
  47 **TUI Commands**:
  48
  49 .. py:function:: model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut)
  50
  51     :param part: The current part object.
  52     :param list: A list of objects for extrusion.
  53     :param number: Size of extrucion.
  54     :param list: A list of objects to cut from.
  55     :return: Created object.
  56
  57 .. py:function:: model.addExtrusionCut(part, objects, direction, size, objectsToCut)
  58
  59     :param part: The current part object.
  60     :param list: A list of objects for extrusion.
  61     :param object: A direction of extrusion
  62     :param number: Size of extrucion.
  63     :param list: A list of objects to cut from.
  64     :return: Created object.
  65
  66 .. py:function:: model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut)
  67
  68     :param part: The current part object.
  69     :param list: A list of objects for extrusion.
  70     :param number: "Size to" value.
  71     :param number: "Size from" value.
  72     :param list: A list of objects to cut from.
  73     :return: Created object.
  74
  75 .. py:function:: model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut)
  76
  77     :param part: The current part object.
  78     :param list: A list of objects for extrusion.
  79     :param object: A direction of extrusion
  80     :param number: "Size to" value.
  81     :param number: "Size from" value.
  82     :param list: A list of objects to cut from.
  83     :return: Created object.
  84
  85 Result
  86 """"""
  87
  88 The Result of the operation will be an extruded shape:
  89
  90 .. image:: images/extrusion_cut_by_sizes_result.png
  91            :align: center
  92
  93 .. centered::
  94    **Created Extrusion Cut**
  95
  96 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_sizes` operation.
  97
  98 By bounding planes
  99 ------------------
 100
 101 .. image:: images/ExtrusionCut2.png
 102   :align: center
 103
 104 .. centered::
 105   Extrusion Cut: definition by bounding planes
 106
 107 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 108 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
 109 - **To plane** - a planar face can be selected to bound extrusion from one side.
 110 - **To offset** - offset for extrusion or for a bounding plane, if selected.
 111 - **From plane** - a planar face can be selected to bound extrusion from the other side.
 112 - **From offset** - offset for extrusion or for a bounding plane, if selected.
 113 - **Cut from** - contains a list of objects which will be cut from the result of extrusion.
 114
 115 **TUI Commands**:
 116
 117 .. py:function:: model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut)
 118
 119     :param part: The current part object.
 120     :param list: A list of objects for extrusion.
 121     :param object: "To object".
 122     :param number: "Offset to" value.
 123     :param object: "From object".
 124     :param number: "Offset from" value.
 125     :param list: A list of objects to cut from.
 126     :return: Created object.
 127
 128 .. py:function:: model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut)
 129
 130     :param part: The current part object.
 131     :param list: A list of objects for extrusion.
 132     :param object: A direction of extrusion
 133     :param object: "To object".
 134     :param number: "Offset to" value.
 135     :param object: "From object".
 136     :param number: "Offset from" value.
 137     :param list: A list of objects to cut from.
 138     :return: Created object.
 139
 140 Result
 141 """"""
 142
 143 The Result of the operation will be an extruded shape:
 144
 145 .. image:: images/extrusion_cut_by_bounding_planes_result.png
 146            :align: center
 147
 148 .. centered::
 149    **Created Extrusion Cut**
 150
 151 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.