src/FeaturesPlugin/doc/commonFeature.rst

   1 .. _featureCommon:
   2
   3 Common
   4 ======
   5
   6 The feature Common implements a boolean operation for extraction of a common part from a set of selected shapes.
   7
   8 To perform a boolean opration Common in the active part:
   9
  10 #. select in the Main Menu *Features - > Common* item  or
  11 #. click **Common** button in the toolbar
  12
  13 .. image:: images/common_btn.png
  14    :align: center
  15
  16 .. centered::
  17    **Common**  button
  18
  19 The following property panel will be opened:
  20
  21 .. image:: images/Common.png
  22   :align: center
  23
  24 .. centered::
  25   **Common operation**
  26
  27 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be common with tool objects.
  28 -  **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be common with main objects.
  29 - **See preview** button shows a result of the operation.
  30
  31 **TUI Command**:  *model.addCommon(Part_doc, mainObjects, toolObjects)*
  32
  33 **Arguments**:   Part + list of main objects + list of tool objects.
  34
  35 Result
  36 """"""
  37
  38 The Result of the operation will be a shape which is a common for all selected shapes:
  39
  40 .. image:: images/CreatedCommon.png
  41            :align: center
  42
  43 .. centered::
  44    **Common created**
  45
  46 **See Also** a sample TUI Script of a :ref:`tui_create_common` operation.