src/FeaturesPlugin/doc/commonFeature.rst

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