Salome HOME
documentation improvement
[modules/geom.git] / doc / salome / gui / GEOM / input / transfer_data.doc
1 /*!
2
3 \page transfer_data_page Transfer Data
4
5 This operation performs copying of non-topological data
6 from one shape to another. The topology of the destination object
7 will not change, only non-topological data will be transferred
8 (if it is present in the source object). It is possible to transfer
9 the following data with this operation:
10 <ul>
11 <li> <b>Names</b></li>
12 <li> <b>Materials</b></li>
13 </ul>
14
15 To use this operation, select in the Main Menu <b>Operations -> Transfer Data</b>.
16 The following dialog box will appear.
17
18 \image html transfer_data1.png "Transfer Data Dialog"
19
20 In this dialog:
21 <ul>
22 <li> <b>Source Shape</b> is an object that is a source of non-topological data.</li>
23 <li> <b>Destination Shape</b> is a data destination object. </li>
24 <li> <b>Type of detection operation</b> is the method to search sub-shapes of
25      <b>Source Shape</b> in <b>Destination Shape</b>. Data are transferred
26      from these corresponding sub-shapes. This is a combo-box with the following
27      possible values:
28     <ul>
29     <li><b>Get In Place</b> - current implementation of Get In Place algorithm
30         (default value).</li>
31     <li><b>Get In Place (old)</b> - old implementation of Get In Place
32         algorithm.</li>
33     <li><b>Get In Place By History</b> - Get In Place By History algorithm.</li>
34     </ul>
35 </li>
36 </ul>
37
38 To copy data click on \b Apply or <b>Apply and Close</b> button. As the result
39 it is possible to see how many names and materials are copied as well as
40 maximum number of names and materials available for copying. This information is
41 provided on the following message box:
42
43 \image html transfer_data2.png "Transfer Data Information"
44
45 <b>TUI Command:</b> <em>geompy.TransferData(ObjectFrom, ObjectTo, FindMethod),</em> 
46 <br> where \em ObjectFrom is a data source object, \em ObjectTo is a
47 destination object and \em FindMethod is a same shape detection method with
48 default value \em GEOM.FSM_GetInPlace.
49
50 Our <b>TUI Scripts</b> provide you with useful example of the use of
51 \ref swig_TransferData "Transfer Data" functionality.
52  
53 */