Salome HOME
Documentation: use 'figure' instead of 'image'; improve caption layout; fix warnings.
[modules/shaper.git] / src / FeaturesPlugin / doc / extrusionCutFeature.rst
index dfa156f036ac79df46ba472b673579e7f76980f8..e6e53562e2617d98efe1bbda61ada8edfe5d3895 100644 (file)
+.. |extrusion_cut_btn.icon|    image:: images/extrusion_cut_btn.png
 
-Extrusion cut
+Extrusion Cut
 =============
 
+Extrusion Cut feature extrudes selected objects along their normals or selected axis and cuts the result from other objects.
 
-.. image:: images/StartSketch.png
-  :align: center
+To perform Extrusion Cut in the active part:
 
-.. centered::
-  Start sketch
+#. select in the Main Menu *Features - > Extrusion Cut* item  or
+#. click |extrusion_cut_btn.icon| **Extrusion Cut** button in the toolbar
 
+The following property panel will be opened:
 
-.. image:: images/ExtrusionCut1.png
-  :align: center
+.. figure:: images/StartSketch.png
+   :align: center
 
-.. centered::
-  Extrusion: definition by sizes
+   Start sketch
 
+There are three variants of the property panel for Extrusion Cut depending on the chosen option:
 
-.. image:: images/ExtrusionCut2.png
-  :align: center
+.. figure:: images/extrusion_by_sizes.png
+   :align: left
+   :height: 24px
 
-.. centered::
-  Extrusion: definition by bounding planes
+**By Sizes** extrudes objects by specifying sizes.
+
+.. figure:: images/extrusion_by_bounding_planes.png
+   :align: left
+   :height: 24px
+
+**By Bounding Planes** extrudes objects by specifying bounding planes and offsets.
+
+.. figure:: images/extrusion_through_all.png
+   :align: left
+   :height: 24px
+
+**Through All** extrudes base objects through all objects to be cut.
+
+--------------------------------------------------------------------------------
+
+By sizes
+--------
+
+.. figure:: images/ExtrusionCut1.png
+   :align: center
+
+   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, 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 to be cut by the result of extrusion.
+
+**TUI Commands**:  
+
+.. py:function:: model.addExtrusionCut(part, objectsToExtrude, size, objectsToCut)
+
+    :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.
+
+.. py:function:: model.addExtrusionCut(part, objects, direction, size, objectsToCut)
+
+    :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.
+
+.. py:function:: model.addExtrusionCut(part, objects, toSize, fromSize, objectsToCut)
+
+    :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.
+
+.. py:function:: model.addExtrusionCut(part, objects, direction, toSize, fromSize, objectsToCut)
+
+    :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
+""""""
+
+The Result of the operation will be an extruded shape:
+
+.. figure:: images/extrusion_cut_by_sizes_result.png
+   :align: center
+
+   **Created Extrusion Cut**
+
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_sizes` operation.
+
+By bounding planes
+------------------
+
+.. figure:: images/ExtrusionCut2.png
+   :align: center
+
+   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, 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 by 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
+""""""
+
+The Result of the operation will be an extruded shape:
+
+.. figure:: images/extrusion_cut_by_bounding_planes_result.png
+   :align: center
+
+   **Created Extrusion Cut**
+
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_by_bounding_planes` operation.
+
+Through all
+-----------
+
+.. figure:: images/ExtrusionCut3.png
+   :align: center
+
+   Extrusion Cut: definition through all objects
+
+- **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.
+- **Cut from** - contains a list of objects to be cut by the result of extrusion.
+
+**TUI Commands**:  
+
+.. py:function:: model.addExtrusionCut(part, objectsToExtrude, objectsToCut)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param list: A list of objects to cut from.
+    :return: Created object.
+
+.. py:function:: model.addExtrusionCut(part, objects, direction, objectsToCut)
+
+    :param part: The current part object.
+    :param list: A list of objects for extrusion.
+    :param object: A direction of extrusion
+    :param list: A list of objects to cut from.
+    :return: Created object.
+
+Result
+""""""
+
+The Result of the operation will be an extruded shape:
+
+.. figure:: images/extrusion_cut_through_all_result.png
+   :align: center
+
+   **Created Extrusion Cut**
+
+**See Also** a sample TUI Script of :ref:`tui_create_extrusion_cut_through_all` operation.