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 - **Fuzzy Parameter** defines the additional tolerance value used to eliminate tiny results.
  43 - **See preview** button shows a result of the operation.
  44
  45 **TUI Command**:
  46
  47 .. py:function:: model.addCommon(Part_doc, objects, fuzzy)
  48
  49     :param part: The current part object
  50     :param list: A list of objects.
  51     :param real: Additional tolerance used to eliminate tiny results (optional).
  52     :return: Created object
  53
  54 Result
  55 """"""
  56
  57 The Result of the operation will be a shape which is a common for all selected shapes:
  58
  59 .. figure:: images/CreatedCommon.png
  60    :align: center
  61
  62    **Common created**
  63
  64 **See Also** a sample TUI Script of :ref:`tui_create_common` operation.
  65
  66 Advanced
  67 --------
  68
  69 .. figure:: images/boolean_common_advanced_property_panel.png
  70    :align: center
  71
  72    **Advanced**
  73
  74 - **Objects** contains a list of objects selected in the Object Browser or in the Viewer.
  75   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
  76   other objects (to avoid self-intersection) and added to the result.
  77 - **Tools** contains a list of objects selected in the Object Browser or in the Viewer, which will be intersected with tool objects.
  78   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
  79 - **Fuzzy Parameter** defines the additional tolerance value used to eliminate tiny results.
  80 - **See preview** button shows a result of the operation.
  81
  82 Any kind of shape is supported as an object or a tool of Common. Moreover, constructions planes can be selected as tools.
  83
  84 **TUI Command**:
  85
  86 .. py:function:: model.addCommon(Part_doc, objects, tools, fuzzy)
  87
  88     :param part: The current part object
  89     :param list: A list of objects.
  90     :param list: A list of tools.
  91     :param real: Additional tolerance used to eliminate tiny results (optional).
  92     :return: Created object
  93
  94 Result
  95 """"""
  96
  97 For each selected object, the common part between this object and all tools will be found:
  98
  99 .. figure:: images/boolean_common_result.png
 100    :align: center
 101
 102    **Created common**
 103
 104 **See Also** a sample TUI Script of :ref:`tui_create_common` operation.