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 three 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 .. image:: images/extrusion_through_all.png
  32    :align: left
  33 **Through All** extrudes base objects through all objects to be cut.
  34
  35
  36 By sizes
  37 --------
  38
  39 .. image:: images/ExtrusionCut1.png
  40   :align: center
  41
  42 .. centered::
  43   Extrusion Cut: definition by sizes
  44
  45 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
  46 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
  47 - **To size**  - size for extrusion in the direction.
  48 - **From size** - size for extrusion in the opposite direction.
  49 - **Cut from** - contains a list of objects to be cut by the result of extrusion.
  50
  51 **TUI Commands**:
  52
  53 .. py:function:: model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut)
  54
  55     :param part: The current part object.
  56     :param list: A list of objects for extrusion.
  57     :param number: Size of extrucion.
  58     :param list: A list of objects to cut from.
  59     :return: Created object.
  60
  61 .. py:function:: model.addExtrusionCut(part, objects, direction, size, objectsToCut)
  62
  63     :param part: The current part object.
  64     :param list: A list of objects for extrusion.
  65     :param object: A direction of extrusion
  66     :param number: Size of extrucion.
  67     :param list: A list of objects to cut from.
  68     :return: Created object.
  69
  70 .. py:function:: model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut)
  71
  72     :param part: The current part object.
  73     :param list: A list of objects for extrusion.
  74     :param number: "Size to" value.
  75     :param number: "Size from" value.
  76     :param list: A list of objects to cut from.
  77     :return: Created object.
  78
  79 .. py:function:: model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut)
  80
  81     :param part: The current part object.
  82     :param list: A list of objects for extrusion.
  83     :param object: A direction of extrusion
  84     :param number: "Size to" value.
  85     :param number: "Size from" value.
  86     :param list: A list of objects to cut from.
  87     :return: Created object.
  88
  89 Result
  90 """"""
  91
  92 The Result of the operation will be an extruded shape:
  93
  94 .. image:: images/extrusion_cut_by_sizes_result.png
  95            :align: center
  96
  97 .. centered::
  98    **Created Extrusion Cut**
  99
 100 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_sizes` operation.
 101
 102 By bounding planes
 103 ------------------
 104
 105 .. image:: images/ExtrusionCut2.png
 106   :align: center
 107
 108 .. centered::
 109   Extrusion Cut: definition by bounding planes
 110
 111 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 112 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
 113 - **To plane** - a planar face can be selected to bound extrusion from one side.
 114 - **To offset** - offset for extrusion or for a bounding plane, if selected.
 115 - **From plane** - a planar face can be selected to bound extrusion from the other side.
 116 - **From offset** - offset for extrusion or for a bounding plane, if selected.
 117 - **Cut from** - contains a list of objects which will be cut by the result of extrusion.
 118
 119 **TUI Commands**:
 120
 121 .. py:function:: model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut)
 122
 123     :param part: The current part object.
 124     :param list: A list of objects for extrusion.
 125     :param object: "To object".
 126     :param number: "Offset to" value.
 127     :param object: "From object".
 128     :param number: "Offset from" value.
 129     :param list: A list of objects to cut from.
 130     :return: Created object.
 131
 132 .. py:function:: model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut)
 133
 134     :param part: The current part object.
 135     :param list: A list of objects for extrusion.
 136     :param object: A direction of extrusion
 137     :param object: "To object".
 138     :param number: "Offset to" value.
 139     :param object: "From object".
 140     :param number: "Offset from" value.
 141     :param list: A list of objects to cut from.
 142     :return: Created object.
 143
 144 Result
 145 """"""
 146
 147 The Result of the operation will be an extruded shape:
 148
 149 .. image:: images/extrusion_cut_by_bounding_planes_result.png
 150            :align: center
 151
 152 .. centered::
 153    **Created Extrusion Cut**
 154
 155 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.
 156
 157 Through all
 158 -----------
 159
 160 .. image:: images/ExtrusionCut3.png
 161   :align: center
 162
 163 .. centered::
 164   Extrusion Cut: definition through all objects
 165
 166 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 167 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
 168 - **Cut from** - contains a list of objects to be cut by the result of extrusion.
 169
 170 **TUI Commands**:
 171
 172 .. py:function:: model.addExtrusionCut(part, objectsToExtrude, objectsToCut)
 173
 174     :param part: The current part object.
 175     :param list: A list of objects for extrusion.
 176     :param list: A list of objects to cut from.
 177     :return: Created object.
 178
 179 .. py:function:: model.addExtrusionCut(part, objects, direction, objectsToCut)
 180
 181     :param part: The current part object.
 182     :param list: A list of objects for extrusion.
 183     :param object: A direction of extrusion
 184     :param list: A list of objects to cut from.
 185     :return: Created object.
 186
 187 Result
 188 """"""
 189
 190 The Result of the operation will be an extruded shape:
 191
 192 .. image:: images/extrusion_cut_through_all_result.png
 193            :align: center
 194
 195 .. centered::
 196    **Created Extrusion Cut**
 197
 198 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_through_all` operation.