src/FeaturesPlugin/doc/fuseFeature.rst

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