src/FeaturesPlugin/doc/smashFeature.rst

   1 .. |bool_smash.icon|    image:: images/bool_smash.png
   2    :height: 16px
   3
   4 Smash
   5 =====
   6
   7 Smash feature implements a boolean operation for smashing a set of main objects by a set of tool objects.
   8
   9 To create a Smash in the active part:
  10
  11 #. select in the Main Menu *Features - > Smash* item  or
  12 #. click |bool_smash.icon| **Smash** button in the toolbar
  13
  14 The following property panel will be opened:
  15
  16 .. image:: images/Smash.png
  17   :align: center
  18
  19 .. centered::
  20   **Smash operation**
  21
  22 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed by tool objects.
  23   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
  24   other objects (to avoid self intersection) and added to the result.
  25 - **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed into main objects.
  26   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
  27 - **See preview** button shows a result of the operation.
  28
  29 **TUI Command**:
  30
  31 .. py:function:: model.addSmash(Part_doc, mainObjects, toolObjects)
  32
  33     :param part: The current part object.
  34     :param list: A list of main objects.
  35     :param list: A list of tool objects.
  36     :return: Rotated object.
  37
  38 Result
  39 """"""
  40
  41 The Result of the operation will be a shape which is a smash of tool objects from main objects:
  42
  43 .. image:: images/CreatedSmash.png
  44            :align: center
  45
  46 .. centered::
  47    **Smash created**
  48
  49 **See Also** a sample TUI Script of :ref:`tui_create_smash` operation.