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 - **See preview** - button shows a result of the operation.
  44
  45 **TUI Command**:
  46
  47 .. py:function:: model.addFuse(Part_doc, objects, isRemoveEdges)
  48
  49     :param part: The current part object.
  50     :param list: A list of objects.
  51     :param boolean: Remove edges flag (optional).
  52     :return: Created object.
  53
  54 Result
  55 """"""
  56
  57 The Result of the operation will be a single shape which is a fuse of selected objects:
  58
  59 .. figure:: images/CreatedFuse.png
  60    :align: center
  61
  62    **Fuse created**
  63
  64 **See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.
  65
  66 Advanced
  67 --------
  68
  69 .. figure:: images/boolean_fuse_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, which will be fused with tool objects.
  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 fused 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 - **Remove intersection edges** - if enabled, edges that lie on the same surface will be removed.
  80 - **See preview** - button shows a result of the operation.
  81
  82 **TUI Command**:
  83
  84 .. py:function:: model.addFuse(Part_doc, objects, tools, isRemoveEdges)
  85
  86     :param part: The current part object.
  87     :param list: A list of objects.
  88     :param list: A list of tools.
  89     :param boolean: Remove edges flag (optional).
  90     :return: Created object.
  91
  92 Result
  93 """"""
  94
  95 The Result of the operation will be a single shape which is a fuse of selected objects and tools:
  96
  97 .. figure:: images/boolean_fuse_result.png
  98    :align: center
  99
 100    **Fuse created**
 101
 102 **See Also** a sample TUI Script of :ref:`tui_create_fuse` operation.