src/FeaturesPlugin/doc/commonFeature.rst

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