src/FeaturesPlugin/doc/extrusionFuseFeature.rst

   1 .. |extrusion_fuse_btn.icon|    image:: images/extrusion_fuse_btn.png
   2
   3 Extrusion Fuse
   4 ==============
   5
   6 Extrusion Fuse feature extrudes selected objects along their normals or the selected axis and fuses the result with other objects.
   7
   8 To perform Extrusion Fuse in the active part:
   9
  10 #. select in the Main Menu *Features - > Extrusion Fuse* item  or
  11 #. click |extrusion_fuse_btn.icon| **Extrusion Fuse** 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 Fuse depending on the chosen option:
  22
  23 .. image:: images/extrusion_by_sizes.png
  24    :align: left
  25    :height: 24px
  26
  27 **By Sizes** extrudes objects by specifying sizes.
  28
  29 .. image:: images/extrusion_by_bounding_planes.png
  30    :align: left
  31    :height: 24px
  32
  33 **By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
  34
  35 .. image:: images/extrusion_through_all.png
  36    :align: left
  37    :height: 24px
  38
  39 **Through All** extrudes base objects to pass through all objects fuse with.
  40
  41 --------------------------------------------------------------------------------
  42
  43 By sizes
  44 --------
  45
  46 .. image:: images/ExtrusionFuse1.png
  47   :align: center
  48
  49 .. centered::
  50   Extrusion Fuse: definition by sizes
  51
  52 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
  53 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
  54 - **To size** - size for extrusion in the direction.
  55 - **From size** - size for extrusion in the opposite direction.
  56 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
  57
  58 **TUI Commands**:
  59
  60 .. py:function:: model.addExtrusionFuse(part, objectsToExtrude, size, objectsToFuse)
  61
  62     :param part: The current part object.
  63     :param list: A list of objects for extrusion.
  64     :param number: Size of extrucion.
  65     :param list: A list of objects to fuse with.
  66     :return: Created object.
  67
  68 .. py:function:: model.addExtrusionFuse(part, objects, direction, size, objectsToFuse)
  69
  70     :param part: The current part object.
  71     :param list: A list of objects for extrusion.
  72     :param object: A direction of extrusion
  73     :param number: Size of extrucion.
  74     :param list: A list of objects to fuse with.
  75     :return: Created object.
  76
  77 .. py:function:: model.addExtrusionFuse(part, objects, toSize, fromSize, objectsToFuse)
  78
  79     :param part: The current part object.
  80     :param list: A list of objects for extrusion.
  81     :param number: "Size to" value.
  82     :param number: "Size from" value.
  83     :param list: A list of objects to fuse with.
  84     :return: Created object.
  85
  86 .. py:function:: model.addExtrusionFuse(part, objects, direction, toSize, fromSize, objectsToFuse)
  87
  88     :param part: The current part object.
  89     :param list: A list of objects for extrusion.
  90     :param object: A direction of extrusion
  91     :param number: "Size to" value.
  92     :param number: "Size from" value.
  93     :param list: A list of objects to fuse with.
  94     :return: Created object.
  95
  96 Result
  97 """"""
  98
  99 The Result of the operation will be an extruded shape:
 100
 101 .. image:: images/extrusion_fuse_by_sizes_result.png
 102            :align: center
 103
 104 .. centered::
 105    **Extrusion Fuse created**
 106
 107 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_sizes` operation.
 108
 109 By bounding planes
 110 ------------------
 111
 112 .. image:: images/ExtrusionFuse2.png
 113   :align: center
 114
 115 .. centered::
 116   Extrusion Fuse: definition by bounding planes
 117
 118 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 119 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
 120 - **To plane** - a planar face can be selected to bound extrusion from one side.
 121 - **To offset** - offset for extrusion or for bounding plane, if selected.
 122 - **From plane** - a planar face can be selected to bound extrusion from the other side.
 123 - **From offset** - offset for extrusion or for bounding plane,  if selected.
 124 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
 125
 126 **TUI Commands**:
 127
 128 .. py:function:: model.addExtrusionFuse(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToFuse)
 129
 130     :param part: The current part object.
 131     :param list: A list of objects for extrusion.
 132     :param object: "To object".
 133     :param number: "To offset".
 134     :param object: "From object".
 135     :param number: "From offset".
 136     :param list: A list of objects to fuse with.
 137     :return: Created object.
 138
 139 .. py:function:: model.addExtrusionFuse(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToFuse)
 140
 141     :param part: The current part object.
 142     :param list: A list of objects for extrusion.
 143     :param object: A direction of extrusion
 144     :param object: "To object".
 145     :param number: "To offset".
 146     :param object: "From object".
 147     :param number: "From offset".
 148     :param list: A list of objects to fuse with.
 149     :return: Created object.
 150
 151 Result
 152 """"""
 153
 154 The Result of the operation will be an extruded shape:
 155
 156 .. image:: images/extrusion_fuse_by_bounding_planes_result.png
 157            :align: center
 158
 159 .. centered::
 160    **Extrusion Fuse created**
 161
 162 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_by_bounding_planes` operation.
 163
 164 Through all
 165 -----------
 166
 167 .. image:: images/ExtrusionFuse3.png
 168   :align: center
 169
 170 .. centered::
 171   Extrusion Fuse: definition through all objects
 172
 173 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 174 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
 175 - **Fuse with** - contains a list of objects which will be fused with the result of extrusion.
 176
 177 **TUI Commands**:
 178
 179 .. py:function:: model.addExtrusionFuse(part, objectsToExtrude, objectsToFuse)
 180
 181     :param part: The current part object.
 182     :param list: A list of objects for extrusion.
 183     :param list: A list of objects to fuse with.
 184     :return: Created object.
 185
 186 .. py:function:: model.addExtrusionFuse(part, objectsToExtrude, direction, objectsToFuse)
 187
 188     :param part: The current part object.
 189     :param list: A list of objects for extrusion.
 190     :param object: A direction of extrusion
 191     :param list: A list of objects to fuse with.
 192     :return: Created object.
 193
 194 Result
 195 """"""
 196
 197 The Result of the operation will be an extruded shape:
 198
 199 .. image:: images/extrusion_fuse_through_all_result.png
 200            :align: center
 201
 202 .. centered::
 203    **Extrusion Fuse created**
 204
 205 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_fuse_through_all` operation.