Task #3016: 3.2 To add a mode «through all» for features RevolutionCut and RevolutionFuse

[modules/shaper.git] / src / FeaturesPlugin / doc / smashFeature.rst

diff --git a/src/FeaturesPlugin/doc/smashFeature.rst b/src/FeaturesPlugin/doc/smashFeature.rst
index e9364a3f741bebff42212fca44fb17437a32dfcf..48225b96289b947a78e483ad0e5a5a3073cc8403 100644 (file)
--- a/src/FeaturesPlugin/doc/smashFeature.rst
+++ b/src/FeaturesPlugin/doc/smashFeature.rst
@@ -1,19 +1,14 @@
+.. |bool_smash.icon|    image:: images/bool_smash.png
 
 Smash
 =====
 
-The feature Smash implements a boolean operation for smashing a set of main objects by a set of tool objects.
+Smash feature implements a boolean operation for smashing a set of main objects by a set of tool objects.
 
-To a create boolean opration Smash in the active part:
+To create a Smash in the active part:
 
 #. select in the Main Menu *Features - > Smash* item  or
-#. click **Smash** button in the toolbar
-
-.. image:: images/bool_smash.png
-   :align: center
-
-.. centered::
-   **Smash**  button 
+#. click |bool_smash.icon| **Smash** button in the toolbar
 
 The following property panel will be opened:
 
@@ -23,15 +18,21 @@ The following property panel will be opened:
 .. centered::
   **Smash operation**
 
-Here it is necessary to select main objects and tool objects.
+- **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.
 
-**Apply** button creates the smash shape.
-  
-**Cancel** button cancels operation.
+**TUI Command**:
 
-**TUI Command**:  *model.addSmash(Part_doc, mainObjects, toolObjects)*
+.. py:function:: model.addSmash(Part_doc, mainObjects, toolObjects)
 
-**Arguments**:   Part + list of main objects + list of tool objects.
+    :param part: The current part object.
+    :param list: A list of main objects.
+    :param list: A list of tool objects.
+    :return: Rotated object.
 
 Result
 """"""
@@ -44,4 +45,4 @@ The Result of the operation will be a shape which is a smash of tool objects fro
 .. centered::
    **Smash created**
 
-**See Also** a sample TUI Script of a :ref:`tui_create_smash` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_smash` operation.