+.. |extrusion_cut_btn.icon| image:: images/extrusion_cut_btn.png
Extrusion Cut
=============
-Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts result from other objects.
+Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts the result from other objects.
To perform Extrusion Cut in the active part:
#. select in the Main Menu *Features - > Extrusion Cut* item or
-#. click **Extrusion Cut** button in the toolbar
-
-.. image:: images/extrusion_cut_btn.png
- :align: center
-
-.. centered::
- **Extrusion Cut** button
+#. click |extrusion_cut_btn.icon| **Extrusion Cut** button in the toolbar
The following property panel will be opened:
.. centered::
Start sketch
-After selecting one of the options property panel for Extrusion Cut will be opened with two variants:
+There are two variants of the property panel for Extrusion Cut depending on the chosen option:
.. image:: images/extrusion_by_sizes.png
:align: left
.. centered::
Extrusion Cut: definition by sizes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To size** size for extrusion along direction.
-- **From size** size for extrusion in opposite direction.
-- **Cut from** contains a list of objects which will but cut with the result of extrusion.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To size** - size for extrusion in the direction.
+- **From size** - size for extrusion in the opposite direction.
+- **Cut from** - contains a list of objects which will be cut from the result of extrusion.
+
+**TUI Commands**:
-**TUI Command**: *model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut)
-**Arguments**: Part + list of objects for extrusion + size + list of objects to cut from.
+ :param part: The current part object.
+ :param list: A list of objects for extrusion.
+ :param number: Size of extrucion.
+ :param list: A list of objects to cut from.
+ :return: Created object.
-**TUI Command**: *model.addExtrusionCut(part, objects, direction, size, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objects, direction, size, objectsToCut)
-**Arguments**: Part + list of objects for extrusion + direction + size + list of objects to cut from.
+ :param part: The current part object.
+ :param list: A list of objects for extrusion.
+ :param object: A direction of extrusion
+ :param number: Size of extrucion.
+ :param list: A list of objects to cut from.
+ :return: Created object.
-**TUI Command**: *model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut)
-**Arguments**: Part + list of objects for extrusion + to size + from size + list of objects to cut from.
+ :param part: The current part object.
+ :param list: A list of objects for extrusion.
+ :param number: "Size to" value.
+ :param number: "Size from" value.
+ :param list: A list of objects to cut from.
+ :return: Created object.
-**TUI Command**: *model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut);*
+.. py:function:: model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut)
-**Arguments**: Part + list of objects for extrusion + direction + to size + from size + list of objects to cut from.
+ :param part: The current part object.
+ :param list: A list of objects for extrusion.
+ :param object: A direction of extrusion
+ :param number: "Size to" value.
+ :param number: "Size from" value.
+ :param list: A list of objects to cut from.
+ :return: Created object.
Result
""""""
:align: center
.. centered::
- **Extrusion Cut created**
+ **Created Extrusion Cut**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_cut_by_sizes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_sizes` operation.
By bounding planes
------------------
.. centered::
Extrusion Cut: definition by bounding planes
-- **Base objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
-- **Axis** if selected then it will be direction of extrusion, otherwise objects normals will be used.
-- **To plane** planar face can be selected to bound extrusion from one side.
-- **To offset** offset for extrusion or for bounding plane if selected.
-- **From plane** planar face can be selected to bound extrusion from other side.
-- **From offset** offset for extrusion or for bounding plane if selected.
-- **Cut from** contains a list of objects which will but cut with the result of extrusion.
-
-**TUI Command**: *model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut);*
-
-**Arguments**: Part + list of objects for extrusion + to object + to offset + from object + from offset + list of objects to cut from.
-
-**TUI Command**: *model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut);*
-
-**Arguments**: Part + list of objects for extrusion + direction + to object + to offset + from object + from offset + list of objects to cut from.
+- **Base objects** - contains a list of objects selected in the Object Browser or in the Viewer, which will be extruded.
+- **Axis** - if selected, it will be the direction of extrusion, otherwise objects normals will be used.
+- **To plane** - a planar face can be selected to bound extrusion from one side.
+- **To offset** - offset for extrusion or for a bounding plane, if selected.
+- **From plane** - a planar face can be selected to bound extrusion from the other side.
+- **From offset** - offset for extrusion or for a bounding plane, if selected.
+- **Cut from** - contains a list of objects which will be cut from the result of extrusion.
+
+**TUI Commands**:
+
+.. py:function:: model.addExtrusionCut(part, objects, toObject, toOffset, fromObject, fromOffset, objectsToCut)
+
+ :param part: The current part object.
+ :param list: A list of objects for extrusion.
+ :param object: "To object".
+ :param number: "Offset to" value.
+ :param object: "From object".
+ :param number: "Offset from" value.
+ :param list: A list of objects to cut from.
+ :return: Created object.
+
+.. py:function:: model.addExtrusionCut(part, objects, direction, toObject, toOffset, fromObject, fromOffset, objectsToCut)
+
+ :param part: The current part object.
+ :param list: A list of objects for extrusion.
+ :param object: A direction of extrusion
+ :param object: "To object".
+ :param number: "Offset to" value.
+ :param object: "From object".
+ :param number: "Offset from" value.
+ :param list: A list of objects to cut from.
+ :return: Created object.
Result
""""""
:align: center
.. centered::
- **Extrusion Cut created**
+ **Created Extrusion Cut**
-**See Also** a sample TUI Script of a :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.
