Salome HOME
26451: Import Result with Groups
[modules/shaper.git] / 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 If the source-part contains one or several groups, which refer to sub-shapes of source results, then these groups are mutually imported
12 as a sub-features of the Import Result feature. The copied groups contain only the elements referring to the imported results.
13
14 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.
15
16 To create a Copy in the active part:
17
18 #. select in the Main Menu *Features - > Import Result* item  or
19 #. click |import_result_btn.icon| **Import Result** button in the toolbar
20
21
22 The following property panel will be opened:
23
24 .. figure:: images/ImportResult.png
25    :align: center
26
27    **Import result operation**
28
29 Here it is necessary to select one or several objects. It is only possible to import results from Parts placed before the
30 current Part where the import is done. Only results from the **Results** folder of previously created parts may be selected.
31
32
33 **Apply** button creates a copy.
34   
35 **Cancel** button cancels the operation.
36
37 **TUI Command**:
38
39 .. py:function:: model.addImportResult(Part_doc, results)
40
41     :param part: The current part object.
42     :param results: A list of results from another part.
43     :return: Result feature Import Result.
44
45 Result
46 """"""
47
48 The Result of the operation will be copy of one or several results selected and groups referring to these results in another part located in the same place:
49
50 .. figure:: images/CreatedImportResult.png
51    :align: center
52
53    **Import result created**
54
55 **See Also** a sample TUI Script of :ref:`tui_create_import_result` operation.