src/BuildPlugin/doc/compoundFeature.rst

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