src/FeaturesPlugin/doc/smashFeature.rst

   1
   2 Smash
   3 =====
   4
   5 Smash feature implements a boolean operation for smashing a set of main objects by a set of tool objects.
   6
   7 To create a Smash in the active part:
   8
   9 #. select in the Main Menu *Features - > Smash* item  or
  10 #. click **Smash** button in the toolbar
  11
  12 .. image:: images/bool_smash.png
  13    :align: center
  14
  15 .. centered::
  16    **Smash**  button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/Smash.png
  21   :align: center
  22
  23 .. centered::
  24   **Smash operation**
  25
  26 - **Main Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed by tool objects.
  27   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be cut from
  28   other objects (to avoid self intersection) and added to the result.
  29 - **Tool Objects** contains a list of objects selected in the Object Browser or in the Viewer, which will be smashed into main objects.
  30   If a subshape that belongs to a compsolid/compound was selected, other shapes of this compsolid/compound will be ignored.
  31 - **See preview** button shows a result of the operation.
  32
  33 **TUI Command**:  *model.addSmash(Part_doc, mainObjects, toolObjects)*
  34
  35 **Arguments**:   Part + list of main objects + list of tool objects.
  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.