Salome HOME
Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse
[modules/shaper.git] / src / FeaturesPlugin / doc / smashFeature.rst
index dbeb1642b7217e723ba071c33e719a5ed9f5ef68..48225b96289b947a78e483ad0e5a5a3073cc8403 100644 (file)
@@ -1,10 +1,48 @@
+.. |bool_smash.icon|    image:: images/bool_smash.png
 
 Smash
 =====
 
+Smash feature implements a boolean operation for smashing a set of main objects by a set of tool objects.
+
+To create a Smash in the active part:
+
+#. select in the Main Menu *Features - > Smash* item  or
+#. click |bool_smash.icon| **Smash** button in the toolbar
+
+The following property panel will be opened:
 
 .. image:: images/Smash.png
   :align: center
 
 .. centered::
-  Smash definition
+  **Smash operation**
+
+- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed by tool objects.
+  If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
+  other objects (to avoid self intersection) and added to the result.
+- **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed into main objects.
+  If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
+- **See preview** button shows a result of the operation.
+
+**TUI Command**:
+
+.. py:function:: model.addSmash(Part_doc, mainObjects, toolObjects)
+
+    :param part: The current part object.
+    :param list: A list of main objects.
+    :param list: A list of tool objects.
+    :return: Rotated object.
+
+Result
+""""""
+
+The Result of the operation will be a shape which is a smash of tool objects from main objects:
+
+.. image:: images/CreatedSmash.png
+          :align: center
+
+.. centered::
+   **Smash created**
+
+**See Also** a sample TUI Script of :ref:`tui_create_smash` operation.