src/FeaturesPlugin/doc/importResultFeature.rst

   1 .. |import_result_btn.icon|    image:: images/import_result_btn.png
   2
   3 Import Result
   4 =============
   5
   6 The Import Result feature allows the user to import one or several results from another Part. If the result of the source-part is
   7 changed, the part and part result that contains the copy-results will be updated. The feature keeps the
   8 copy-shape, so, even the document was opened and the source-part was not activated (loaded), the part with copy-feature works well
   9 with this result-shape.
  10
  11 It may be necessary for the user to load the other parts before using this feature otherwise the content of the **Results** folders will be empty.
  12
  13 To create a Copy in the active part:
  14
  15 #. select in the Main Menu *Features - > Import Result* item  or
  16 #. click |import_result_btn.icon| **Import Result** button in the toolbar
  17
  18
  19 The following property panel will be opened:
  20
  21 .. image:: images/ImportResult.png
  22   :align: center
  23
  24 .. centered::
  25    **Import result operation**
  26
  27 Here it is necessary to select one or several objects. It is only possible to import results from Parts placed before the
  28 current Part where the import is done. Only results from the **Results** folder of previously created parts may be selected.
  29
  30
  31 **Apply** button creates a copy.
  32
  33 **Cancel** button cancels the operation.
  34
  35 **TUI Command**:
  36
  37 .. py:function:: model.addImportResult(Part_doc, results)
  38
  39     :param part: The current part object.
  40     :param results: A list of results from another part.
  41     :return: Result feature Import Result.
  42
  43 Result
  44 """"""
  45
  46 The Result of the operation will be copy of one or several results selected in another part located in the same place:
  47
  48 .. image:: images/CreatedImportResult.png
  49            :align: center
  50
  51 .. centered::
  52    **Import result created**
  53
  54 **See Also** a sample TUI Script of :ref:`tui_create_import_result` operation.