Salome HOME
Synchronize adm files
[modules/geom.git] / doc / salome / gui / GEOM / input / modify_location_operation.doc
1 /*!
2
3 \page modify_location_operation_page Modify the Location
4
5 \n To <b>Modify the Location</b> in the <b>Main Menu</b> select 
6 <b>Operations - > Transformation - > Modify the Location</b>.
7
8 \n This operation modifies the \b Location of \b Objects.
9
10 \n The first algorithm places the \b Object(s) so that its center coincides
11 with the origin of the <b>Local Coordinate System</b>. 
12 \n <b>Create a copy</b> checkbox allows to keep the initial objects, otherwise they
13 will be removed.
14 \n <b>Arguments:</b> Name + one or several objects + End Coordinate System.
15 \n \ref restore_presentation_parameters_page "Advanced options".
16
17 \image html transformation5.png
18
19 \n In the picture the initial cube with the global coordinate system
20 is to the right and the modified cube with the Local Coordinate
21 System in the center of it is to the left .
22
23 \image html image30.png
24
25 \n The second algorithm  modifies the location of the \b Object(s) using \b Start
26 and \b End \b LCS, although the final position of the object will not
27 coincide with the center of  either of the two systems. In this method
28 the object is shifted from its initial position by the value of the
29 remainder after subtraction of the coordinates of the <b>Start LCS</b> from
30 the coordinates of the <b>End LCS</b>.
31 \n <b>Create a copy</b> checkbox allows to keep the initial object,
32 otherwise it will be removed.
33 \n <b>Arguments:</b> Name + one or several objects + Start Coordinate System + End
34 Coordinate System.
35 \n \ref restore_presentation_parameters_page "Advanced options".
36
37 \image html transformation6.png
38
39 In this picture we see the initial cube with the global coordinate
40 system and two LCS: LocalCS1 (GCS+100 along x-axis) and LocalCS2
41 (GCS+200 along x-axis)
42
43 \image html image1.png
44
45 Selecting Start LCS = LCS1 and End LCS = LCS2, we obtain the
46 translated cube at the position (100;0;0)
47
48 \image html image21.png
49
50 Selecting Start LCS = LCS2 and End LCS = LCS1, we obtain the
51 translated cube at the position (-100;0;0)
52
53 \image html image4.png
54
55 The third algorithm modifies the location of the \b Object(s) using the <b>Path object</b> (Wire or Edge)
56 and the \b Distance parameter (ranging from 0 to 1) defining  how far the object will move along the path.
57 \n <b>Create a copy</b> checkbox allows to keep the initial object,
58 otherwise it will be removed.
59 \n <b>Select Unpublished edges</b> checkbox allows to select sub-shape edges on
60 the other objects.
61 \n <b>Reverse Direction</b> checkbox allows to REVERSE the direction of the object movement along its path.
62
63 <b>Arguments:</b> Name + one or several objects + Translation path.
64 \n \ref restore_presentation_parameters_page "Advanced options".
65    
66 \image html transformation13.png
67
68 \image html transformation12.png
69
70 \image html transformation14.png
71
72 \n <b>TUI Command:</b> <em>geompy.MakePosition(theObject, theStartLCS,
73 theEndLCS),</em>  where \em theObject is a shape, location of which is
74 modified, \em theStartLCS is a location to move the shape from, \em
75 theEndLCS is a location to move the shape to.
76
77 \n Our <b>TUI Scripts</b> provide you with useful examples of the use
78 of \ref tui_modify_location "Transformation Operations".
79
80 */