src/FeaturesPlugin/doc/commonFeature.rst

   1 Common
   2 ======
   3
   4 Common feature implements a Boolean operation for extraction of a common part from a set of selected shapes.
   5
   6 To perform a Common operation in the active part:
   7
   8 #. select in the Main Menu *Features - > Common* item  or
   9 #. click **Common** button in the toolbar
  10
  11 .. image:: images/bool_common.png
  12    :align: center
  13
  14 .. centered::
  15    **Common**  button
  16
  17 There are 2 options for creation of a Common:
  18
  19 .. image:: images/bool_common_simple.png
  20    :align: left
  21 **Simple** common part between all selected objects.
  22
  23 .. image:: images/bool_common_advanced.png
  24    :align: left
  25 **Advanced** common part for each object between this object and all tools.
  26
  27
  28 Simple
  29 ------
  30
  31 .. image:: images/boolean_common_simple_property_panel.png
  32    :align: center
  33
  34 .. centered::
  35    **Simple**
  36
  37 - **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
  38   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
  39 - **See preview** button shows a result of the operation.
  40
  41 **TUI Command**:  *model.addCommon(Part_doc, objects)*
  42
  43 **Arguments**:   Part + list of objects.
  44
  45 Result
  46 """"""
  47
  48 The Result of the operation will be a shape which is a common for all selected shapes:
  49
  50 .. image:: images/CreatedCommon.png
  51            :align: center
  52
  53 .. centered::
  54    **Common created**
  55
  56 **See Also** a sample TUI Script of :ref:`tui_create_common` operation.
  57
  58 Advanced
  59 --------
  60
  61 .. image:: images/boolean_common_advanced_property_panel.png
  62    :align: center
  63
  64 .. centered::
  65    **Advanced**
  66
  67 - **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
  68   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
  69   other objects (to avoid self-intersection) and added to the result.
  70 - **Tools** contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
  71   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound  will be ignored.
  72 - **See preview** button shows a result of the operation.
  73
  74 **TUI Command**:  *model.addCommon(Part_doc, objects, tools)*
  75
  76 **Arguments**:   Part + list of objects + list of tools.
  77
  78 Result
  79 """"""
  80
  81 For each selected object, the common part between this object and all tools will be found:
  82
  83 .. image:: images/boolean_common_result.png
  84            :align: center
  85
  86 .. centered::
  87    **Created common**
  88
  89 **See Also** a sample TUI Script of :ref:`tui_create_common` operation.