src/FeaturesPlugin/doc/smashFeature.rst

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