src/FeaturesPlugin/doc/commonFeature.rst

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