Salome HOME
small modification
[modules/geom.git] / doc / salome / gui / GEOM / input / multi_rotation_operation.doc
index 7ad469f890ca6cc92ba05669d52c56c5373bee3c..cdc6234a17ded3960aa4ae1c80f2b5d447d4f513 100644 (file)
@@ -12,7 +12,9 @@ or two dimensions basing on the initial geometrical object.
 \n To produce a <b>Simple Multi Rotation</b> (in one dimension) you
 need to define a \b Shape to be rotated, an \b Axis of rotation and a
 <b>Number of Times</b> the shape must be rotated. <b>Rotation Angle</b> will
-be 2*PI/NbTimes
+be 2 * \a PI / \a NbTimes. Number of shapes in the resulting compound will be equal
+to \a NbTimes (if \a NbTimes = 1, the result will contain only the initial
+non-transformed shape).
 \n <b>TUI Command:</b> <em>geompy.MultiRotate1D(Shape, Axis, NbTimes)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 value
 (repetition).
@@ -24,15 +26,18 @@ the same way, but the Axis is defined  by direction and point.
 
 \image html neo-mrot1.png
 
-\image html multi_rotation1d1.png
+\image html multi_rotation1d1.png "The initial object"
 
-\image html multi_rotation1d2.png
+\image html multi_rotation1d2.png "The result of a simple multi-rotation"
 
 \n <b>Double Multi Rotation</b> (in two dimensions) rotates the given
 \b Object around the given \b Axis on the given \b Angle a given
 <b>Number of Times</b> and multi-translates each rotation
 result. Translation direction passes through the center of gravity of
-the rotated shape and its projection on the rotation axis.
+the rotated shape and its projection on the rotation axis. Number of
+shapes in the resulting compound will be equal to \a NbTimes1 x \a NbTimes2 (if
+both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain
+only the initial non-transformed shape).
 \b Reverse checkbox allows to set the direction of rotation.
 \n <b>TUI Command:</b> <em>geompy.MultiRotate2D(Shape, Axis, Angle, NbTimes1, Step, NbTimes2)</em>
 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 angle
@@ -46,9 +51,9 @@ but the Axis is defined  by direction and point.
 
 \image html neo-mrot2.png
 
-\image html multi_rotation2d1.png
+\image html multi_rotation2d1.png "The initial object"
 
-\image html multi_rotation2d2.png
+\image html multi_rotation2d2.png "The result of a double multi-rotation"
 
 Our <b>TUI Scripts</b> provide you with useful examples of the use of
 \ref tui_multi_rotation "Transformation Operations".