Salome HOME
Fix compilation error (conflict of OK name between OCCT Plate_Plate.hxx and GEOM...
[modules/geom.git] / doc / salome / gui / GEOM / input / scale_operation.doc
1 /*!
2
3 \page scale_operation_page Scale Transform
4
5 \n To produce a <b>Scale Transform</b> in the <b>Main Menu</b> select
6 <b>Operations - > Transformation - > Scale Transform</b>
7
8 \n This operation creates a scaled shape basing on the initial
9 shape. 
10
11 \n <b>Simple scale</b> scales the entire object (i.e. its dimensions change evenly in all three orthogonal directions). It does not modify the
12 geometry of the shape.
13  
14 \image html transformation10.png
15
16 The following parameters and options can be defined in this dialog:
17 - <b>Result Name</b>;
18 - One or several <b> Objects </b> to be scaled;
19 - <b>Central Point</b> (optional) - relatively to which the object is scaled. If the <b>Central Point</b> is not defined, the scaling will be
20 performed relatively the origin of the global coordinate system.
21 - <b>Scale Factor</b> - the multiplier of axial dimensions. If <b>Scale Factor</b> is negative, the object is mirrored through the <b>Central Point</b>. 
22 - \ref restore_presentation_parameters_page "Advanced options".
23
24 \n <b>TUI Command:</b> <em>geompy.MakeScaleTransform(Shape, CenterOfScale, Factor)</em>
25 \n <b>Arguments:</b> Name + 1 shape(s) + 1 vertex + 1 Scale Factor.
26
27 \n <b>Multiple scale</b> allows scaling by different factors along axes. This is a general transformation, which can modify the geometry, for example, a
28 circle can be transformed into an ellipse. 
29
30 \image html transformation10a.png
31
32 The following parameters and options can be defined in this dialog:
33 - <b>Result Name</b>;
34 - One or several <b> Objects </b> to be scaled;
35 - <b>Central Point</b> (optional) - relatively to which the object is scaled. 
36 - <b>Scale Factor X/Y/Z</b> -  the multipliers of axial dimensions.  
37 - \ref restore_presentation_parameters_page "Advanced options".
38
39 \n <b>TUI Command:</b> <em>geompy.MakeScaleAlongAxes(Shape, CenterOfScale, FactorX, FactorY, FactorZ)</em>
40 \n <b>Arguments:</b> Name + 1 shape(s) + 1 vertex + 3 Scale Factors.
41
42
43 \n <b>Example of simple scaling:</b>
44
45 \image html scale_transformsn1.png "The initial object"
46
47 \image html scale_transformsn2.png "The resulting object (resized)"
48
49 \n <b>Example of scaling by different factors along axes:</b>
50
51 \image html scale_transformsn3.png "The initial object"
52
53 \image html scale_transformsn4.png "The resulting object (resized and distorted)"
54
55 Our <b>TUI Scripts</b> provide you with useful examples of the use of
56 \ref tui_scale "Scale Transformation" and of \ref swig_scale "Scale Along Axes Transformation"
57
58 */