Salome HOME
9ce13b3f8cd07e049ed3204017e8dcab8107f1d8
[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 object(s) so that its center coincides
11 with the origin of the Local Coordinate System. 
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 <b>Advanced option:</b>
16    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
17
18 \image html transformation5.png
19
20 \n In the picture the initial cube with the global coordinate system
21 is to the right and the modified cube with the Local Coordinate
22 System in the center of it is to the left .
23
24 \image html image30.gif
25
26 \n The second algorithm  modifies the location of an object using Start
27 and End LSC, although the final position of the object will not
28 coincide with the center of  either of the two systems. In this method
29 the object is shifted from its initial position by the value of the
30 remainder after subtraction of the coordinates of the Start LSC from
31 the coordinates of the End LSC.
32 \n <b>Create a copy</b> checkbox allows to keep the initial object,
33 otherwise it will be removed.
34 \n <b>Arguments:</b> Name + one or several objects + Start Coordinate System + End
35 Coordinate System.
36 \n <b>Advanced option:</b>
37    \ref restore_presentation_parameters_page "Set presentation parameters and subshapes from arguments".
38
39 \image html transformation6.png
40
41 In this picture we see the initial cube with the global coordinate
42 system and two LCS: LocalCS1 (GCS+100 along x-axis) and LocalCS2
43 (GCS+200 along x-axis)
44
45 \image html image1.gif
46
47 Selecting Start LCS = LCS1 and End LCS = LCS2, we obtain the
48 translated cube at the position (100;0;0)
49
50 \image html image2.gif
51
52 Selecting Start LCS = LCS2 and End LCS = LCS1, we obtain the
53 translated cube at the position (-100;0;0)
54
55 \image html image4.gif
56
57 The third algorithm modifies the location of an object using the Path object (Wire or Edge)
58 and the Distance parameter (ranging from 0 to 1) defining  how far the object will move along the path.
59 \n <b>Create a copy</b> checkbox allows to keep the initial object,
60 otherwise it will be removed.
61 \n <b>Select Unpublished edges</b> checkbox allows to select subshape edges on
62 the other objects.
63 \n <b>Reverse Direction</b> checkbox allows to REVERSE the direction of the object movement along its path.
64
65 <b>Arguments:</b> Name + one or several objects + Translation path.
66 \n <b>Advanced option:</b>
67    \ref restore_presentation_parameters_page "Set presentation
68    parameters and subshapes from arguments".
69    
70 \image html transformation13.png
71
72 \image html transformation12.png
73
74 \image html transformation14.png
75
76 \n <b>TUI Command:</b> <em>geompy.MakePosition(theObject, theStartLCS,
77 theEndLCS),</em>  where \em theObject is a shape, location of which is
78 modified, \em theStartLCS is a location to move the shape from, \em
79 theEndLCS is a location to move the shape to.
80
81 \n Our <b>TUI Scripts</b> provide you with useful examples of the use
82 of \ref tui_modify_location "Transformation Operations".
83
84 */