src/FeaturesPlugin/doc/extrusionFeature.rst

   1 .. |extrusion_btn.icon|    image:: images/extrusion_btn.png
   2
   3 Extrusion
   4 =========
   5
   6 Extrusion feature extrudes selected objects along their normals or the selected axis.
   7
   8 To perform Extrusion in the active part:
   9
  10 #. select in the Main Menu *Features - > Extrusion* item  or
  11 #. click |extrusion_btn.icon| **Extrusion** 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 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 Faces** extrudes objects by specifying bounding faces/planes and offsets.
  34
  35 --------------------------------------------------------------------------------
  36
  37 By sizes
  38 --------
  39
  40 .. image:: images/Extrusion1.png
  41   :align: center
  42
  43 .. centered::
  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 .. image:: images/extrusion_by_sizes_result.png
  91            :align: center
  92
  93 .. centered::
  94    **Created Extrusion**
  95
  96 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_sizes` operation.
  97
  98 By bounding faces
  99 ------------------
 100
 101 .. image:: images/Extrusion2.png
 102   :align: center
 103
 104 .. centered::
 105   Extrusion: definition by bounding faces
 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 direction of extrusion, otherwise objects normals will be used.
 109 - **To face** - a face can be selected to bound extrusion from one side.
 110 - **To offset** - offset for extrusion or for bounding plane, if selected.
 111 - **From face** - a face can be selected to bound extrusion from the other side.
 112 - **From offset** - offset for extrusion or for bounding plane, if selected.
 113
 114 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.
 115 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.
 116
 117 **TUI Commands**:
 118
 119 .. py:function:: model.addExtrusion(part, objects, toObject, toOffset, fromObject, fromOffset)
 120
 121     :param part: The current part object.
 122     :param list: A list of objects for extrusion.
 123     :param object: "To object"
 124     :param number: "To offset".
 125     :param object: "From object"
 126     :param number: "From offset".
 127     :return: Created object.
 128
 129 .. py:function:: model.addExtrusion(part, objects, direction, toObject, toOffset, fromObject, fromOffset)
 130
 131     :param part: The current part object.
 132     :param list: A list of objects for extrusion.
 133     :param object: A direction of extrusion
 134     :param object: "To object"
 135     :param number: "To offset".
 136     :param object: "From object"
 137     :param number: "From offset".
 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_by_bounding_planes_result.png
 146            :align: center
 147
 148 .. centered::
 149    **Created Extrusion**
 150
 151 **See Also** a sample TUI Script of :ref:`tui_create_extrusion_by_bounding_planes` operation.