src/BuildPlugin/doc/compoundFeature.rst

   1
   2 Compound
   3 ========
   4
   5 Compound feature creates a compound using shapes already existing in other objects.
   6
   7 To create a compound in the active part:
   8
   9 #. select in the Main Menu *Build - > Compound* item  or
  10 #. click **Compound** button in the toolbar
  11
  12 .. image:: images/feature_compound.png
  13   :align: center
  14
  15 .. centered::
  16   **Compound** button
  17
  18 The following property panel will be opened:
  19
  20 .. image:: images/Compound.png
  21   :align: center
  22
  23 .. centered::
  24   Create a compound
  25
  26 Select one or several shapes in the viewer. The selected shapes can be of any type (vertex, edge, face, etc.)
  27
  28 **Apply** button creates a compound.
  29
  30 **Cancel** button cancels the operation.
  31
  32 **TUI Command**:  *model.addCompound(Part_doc, Shapes)*
  33
  34 **Arguments**:   Part document + a list of shapes.
  35
  36 Result
  37 """"""
  38
  39 The result of the operation will be a compound created from the selected shapes:
  40
  41 .. image:: images/CreateCompound.png
  42   :align: center
  43
  44 .. centered::
  45   Result of the operation.
  46
  47 **See Also** a sample TUI Script of :ref:`tui_create_compound` operation.