Salome HOME
Improve ExchangePlugin code coverage
[modules/shaper.git] / src / FeaturesPlugin / doc / commonFeature.rst
index 7324955eb634f4e7fb15a0cb1966ecbf1f803a52..e5bf0c425ebc657d84e94e0c508c6a9131fc2788 100644 (file)
@@ -1,35 +1,46 @@
-
 Common
 ======
 
-The feature Common implements a boolean operation for extraction of a common part from a set of selected shapes.
+Common feature implements a Boolean operation for extraction of a common part from a set of selected shapes.
 
-To perform a boolean opration Common in the active part:
+To perform a Common operation in the active part:
 
 #. select in the Main Menu *Features - > Common* item  or
 #. click **Common** button in the toolbar
 
-.. image:: images/common_btn.png
+.. image:: images/bool_common.png
    :align: center
 
 .. centered::
    **Common**  button 
 
-The following property panel will be opened:
-   
-.. image:: images/Common.png
-  :align: center
+There are 2 options for creation of a Common:
+
+.. image:: images/bool_common_simple.png
+   :align: left
+**Simple** common part between all selected objects.
+
+.. image:: images/bool_common_advanced.png
+   :align: left
+**Advanced** common part for each object between this object and all tools.
+
+
+Simple
+------
+
+.. image:: images/boolean_common_simple_property_panel.png
+   :align: center
 
 .. centered::
-  **Common operation**
+   **Simple**
 
-- **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be common with tool objects.
--  **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be common with main objects.
+- **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
+  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**:  *model.addCommon(Part_doc, mainObjects, toolObjects)*
+**TUI Command**:  *model.addCommon(Part_doc, objects)*
 
-**Arguments**:   Part + list of main objects + list of tool objects.
+**Arguments**:   Part + list of objects.
 
 Result
 """"""
@@ -42,4 +53,37 @@ The Result of the operation will be a shape which is a common for all selected s
 .. centered::
    **Common created**
 
-**See Also** a sample TUI Script of a :ref:`tui_create_common` operation.
+**See Also** a sample TUI Script of :ref:`tui_create_common` operation.
+
+Advanced
+--------
+
+.. image:: images/boolean_common_advanced_property_panel.png
+   :align: center
+
+.. centered::
+   **Advanced**
+
+- **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
+  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.
+- **Tools** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool 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**:  *model.addCommon(Part_doc, objects, tools)*
+
+**Arguments**:   Part + list of objects + list of tools.
+
+Result
+""""""
+
+For each selected object, the common part between this object and all tools will be found:
+
+.. image:: images/boolean_common_result.png
+          :align: center
+
+.. centered::
+   **Created common**
+
+**See Also** a sample TUI Script of :ref:`tui_create_common` operation.