src/FeaturesPlugin/doc/smashFeature.rst

   1
   2 Smash
   3 =====
   4
   5 The feature Smash implements a boolean operation for smashing a set of main objects by a set of tool objects.
   6
   7 To a create boolean opration 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 Here it is necessary to select main objects and tool objects.
  27
  28 **Apply** button creates the smash shape.
  29
  30 **Cancel** button cancels operation.
  31
  32 **TUI Command**:  *model.addSmash(Part_doc, mainObjects, toolObjects)*
  33
  34 **Arguments**:   Part + list of main objects + list of tool objects.
  35
  36 Result
  37 """"""
  38
  39 The Result of the operation will be a shape which is a smash of tool objects from main objects:
  40
  41 .. image:: images/CreatedSmash.png
  42            :align: center
  43
  44 .. centered::
  45    **Smash created**
  46
  47 **See Also** a sample TUI Script of a :ref:`tui_create_smash` operation.