src/FeaturesPlugin/doc/fuseFeature.rst

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