src/FeaturesPlugin/doc/fuseFeature.rst

   1 .. |bool_fuse.icon|    image:: images/bool_fuse.png
   2    :height: 16px
   3
   4 .. _featureFuse:
   5
   6 Fuse
   7 ====
   8
   9 Fuse feature implements a Boolean operation for fusion of a set of main objects with a set of tool objects.
  10
  11 To perform Fuse in the active part:
  12
  13 #. select in the Main Menu *Features - > Fuse* item  or
  14 #. click |bool_fuse.icon| **Fuse** button in the toolbar
  15
  16 There are 2 options for creation of a Fuse:
  17
  18 .. figure:: images/bool_fuse_simple.png
  19    :align: left
  20    :height: 24px
  21
  22 **Simple** simply fuses selected objects.
  23
  24 .. figure:: images/bool_fuse_advanced.png
  25    :align: left
  26    :height: 24px
  27
  28 **Advanced** fuse with additional functionality for subshapes of compsolids/compounds.
  29
  30 --------------------------------------------------------------------------------
  31
  32 Simple
  33 ------
  34
  35 .. figure:: images/boolean_fuse_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, which will be fused to a single result.
  41   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will cut the fuse shape then will be joined to the result.
  42 - **Remove intersection edges** -  if enabled, edges that lie on the same surface will be removed.
  43 - **Fuzzy Parameter** - defines the additional tolerance value used to eliminate tiny results.
  44 - **See preview** - button shows a result of the operation.
  45
  46 **TUI Command**:
  47
  48 .. py:function:: model.addFuse(Part_doc, objects, isRemoveEdges, fuzzyParam)
  49
  50     :param part: The current part object.
  51     :param list: A list of objects.
  52     :param boolean: Remove edges flag (optional).
  53     :param real: Additional tolerance used to eliminate tiny results (optional).
  54     :return: Created object.
  55
  56 Result
  57 """"""
  58
  59 The Result of the operation will be a single shape which is a fuse of selected objects:
  60
  61 .. figure:: images/CreatedFuse.png
  62    :align: center
  63
  64    **Fuse created**
  65
  66 **See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.
  67
  68 Advanced
  69 --------
  70
  71 .. figure:: images/boolean_fuse_advanced_property_panel.png
  72    :align: center
  73
  74    **Advanced**
  75
  76 - **Objects** - 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 cut from
  78   other objects (to avoid self intersection) and added to the result.
  79 - **Tools** - contains a list of objects selected in the Object Browser or in the Viewer, which will be fused with tool objects.
  80   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
  81 - **Remove intersection edges** - if enabled, edges that lie on the same surface will be removed.
  82 - **Fuzzy Parameter** - defines the additional tolerance value used to eliminate tiny results.
  83 - **See preview** - button shows a result of the operation.
  84
  85 **TUI Command**:
  86
  87 .. py:function:: model.addFuse(Part_doc, objects, tools, isRemoveEdges, fuzzyParam)
  88
  89     :param part: The current part object.
  90     :param list: A list of objects.
  91     :param list: A list of tools.
  92     :param boolean: Remove edges flag (optional).
  93     :param real: Additional tolerance used to eliminate tiny results (optional).
  94     :return: Created object.
  95
  96 Result
  97 """"""
  98
  99 The Result of the operation will be a single shape which is a fuse of selected objects and tools:
 100
 101 .. figure:: images/boolean_fuse_result.png
 102    :align: center
 103
 104    **Fuse created**
 105
 106 **See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.