src/FeaturesPlugin/doc/extrusionFeature.rst

   1 .. |extrusion_btn.icon|    image:: images/extrusion_btn.png
   2
   3 .. _featureExtrusion:
   4
   5 Extrusion
   6 =========
   7
   8 Extrusion feature extrudes selected objects along their normals or the selected axis.
   9
  10 To perform Extrusion in the active part:
  11
  12 #. select in the Main Menu *Features - > Extrusion* item  or
  13 #. click |extrusion_btn.icon| **Extrusion** button in the toolbar
  14
  15 The following property panel will be opened:
  16
  17 .. figure:: images/StartSketch.png
  18    :align: center
  19
  20    Start sketch
  21
  22 There are two variants of the property panel for Extrusion depending on the chosen option:
  23
  24 .. figure:: images/extrusion_by_sizes.png
  25    :align: left
  26    :height: 24px
  27
  28 **By Sizes** extrudes objects by specifying sizes.
  29
  30 .. figure:: images/extrusion_by_bounding_planes.png
  31    :align: left
  32    :height: 24px
  33
  34 **By Bounding Faces** extrudes objects by specifying bounding faces/planes and offsets.
  35
  36 --------------------------------------------------------------------------------
  37
  38 By sizes
  39 --------
  40
  41 .. figure:: images/Extrusion1.png
  42    :align: center
  43
  44    Extrusion: definition by sizes
  45
  46 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
  47 - **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
  48 - **To size** - size for extrusion in the direction.
  49 - **From size** - size for extrusion in the opposite direction.
  50
  51 **TUI Commands**:
  52
  53 .. py:function:: model.addExtrusion(part, objects, size)
  54
  55     :param part: The current part object.
  56     :param list: A list of objects for extrusion.
  57     :param number: Size of extrucion.
  58     :return: Created object.
  59
  60 .. py:function:: model.addExtrusion(part, objects, direction, size)
  61
  62     :param part: The current part object.
  63     :param list: A list of objects for extrusion.
  64     :param object: A direction of extrusion
  65     :param number: Size of extrucion.
  66     :return: Created object.
  67
  68 .. py:function:: model.addExtrusion(part, objects, toSize, fromSize)
  69
  70     :param part: The current part object.
  71     :param list: A list of objects for extrusion.
  72     :param number: "Size to" value.
  73     :param number: "Size from" value.
  74     :return: Created object.
  75
  76 .. py:function:: model.addExtrusion(part, objects, direction, toSize, fromSize)
  77
  78     :param part: The current part object.
  79     :param list: A list of objects for extrusion.
  80     :param object: A direction of extrusion
  81     :param number: "Size to" value.
  82     :param number: "Size from" value.
  83     :return: Created object.
  84
  85 Result
  86 """"""
  87
  88 The Result of the operation will be an extruded shape:
  89
  90 .. figure:: images/extrusion_by_sizes_result.png
  91    :align: center
  92
  93    **Created Extrusion**
  94
  95 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_sizes` operation.
  96
  97 By bounding faces
  98 ------------------
  99
 100 .. figure:: images/Extrusion2.png
 101    :align: center
 102
 103    Extrusion: definition by bounding faces
 104
 105 - **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
 106 - **Axis** if selected, it will be direction of extrusion, otherwise objects normals will be used.
 107 - **To face** - a face can be selected to bound extrusion from one side.
 108 - **To offset** - offset for extrusion or for bounding plane, if selected.
 109 - **From face** - a face can be selected to bound extrusion from the other side.
 110 - **From offset** - offset for extrusion or for bounding plane, if selected.
 111
 112 Planar face selected as a boundary of extrusion will be enlarged infinitely. As a result, extrusion bounded only by planar faces will be completed always.
 113 On the other hand, if the boundary face is not planar, extrusion may fail, for example, in case of the base object cannot be projected to this face along given direction.
 114
 115 **TUI Commands**:
 116
 117 .. py:function:: model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset)
 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: "To offset".
 123     :param object: "From object"
 124     :param number: "From offset".
 125     :return: Created object.
 126
 127 .. py:function:: model.addExtrusion(part, objects, direction, toObject, toOffset, fromObject, fromOffset)
 128
 129     :param part: The current part object.
 130     :param list: A list of objects for extrusion.
 131     :param object: A direction of extrusion
 132     :param object: "To object"
 133     :param number: "To offset".
 134     :param object: "From object"
 135     :param number: "From offset".
 136     :return: Created object.
 137
 138 Result
 139 """"""
 140
 141 The Result of the operation will be an extruded shape:
 142
 143 .. figure:: images/extrusion_by_bounding_planes_result.png
 144    :align: center
 145
 146    **Created Extrusion**
 147
 148 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_bounding_planes` operation.