doc/salome/gui/GEOM/input/multi_rotation_operation.doc

   1 /*!
   2
   3 \page multi_rotation_operation_page Multi Rotation
   4
   5 \n To produce a <b>Multi Rotation</b> in the <b>Main Menu</b> select
   6 <b>Operations - > Transformation - > Multi Rotation</b>
   7
   8 \n This operation creates several geometrical objects rotated in one
   9 or two dimensions basing on the initial geometrical object.
  10 \n The \b Result will be one or several \b GEOM_Objects (compound).
  11
  12 \n To produce a <b>Simple Multi Rotation</b> (in one dimension) you
  13 need to define a \b Shape to be rotated, an \b Axis of rotation and a
  14 <b>Number of Times</b> the shape must be rotated. <b>Rotation Angle</b> will
  15 be 2 * \a PI / \a NbTimes. Number of shapes in the resulting compound will be equal
  16 to \a NbTimes (if \a NbTimes = 1, the result will contain only the initial
  17 non-transformed shape).
  18 \n <b>TUI Command:</b> <em>geompy.MultiRotate1D(Shape, Axis, NbTimes)</em>
  19 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 value
  20 (repetition).
  21
  22 \b <b>NB!</b> There is another way to execute a Multi-rotation
  23 operation, which is currently accessible only via TUI commands:
  24 <em>geompy.MakeMultiRotation1D(Shape, Dir, Point, NbTimes)</em> which works in
  25 the same way, but the Axis is defined  by direction and point.
  26
  27 \image html neo-mrot1.png
  28
  29 \image html multi_rotation1d1.png "The initial object"
  30
  31 \image html multi_rotation1d2.png "The result of a simple multi-rotation"
  32
  33 \n <b>Double Multi Rotation</b> (in two dimensions) rotates the given
  34 \b Object around the given \b Axis on the given \b Angle a given
  35 <b>Number of Times</b> and multi-translates each rotation
  36 result. Translation direction passes through the center of gravity of
  37 the rotated shape and its projection on the rotation axis. Number of
  38 shapes in the resulting compound will be equal to \a NbTimes1 x \a NbTimes2 (if
  39 both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain
  40 only the initial non-transformed shape).
  41 \b Reverse checkbox allows to set the direction of rotation.
  42 \n <b>TUI Command:</b> <em>geompy.MultiRotate2D(Shape, Axis, Angle, NbTimes1, Step, NbTimes2)</em>
  43 \n <b>Arguments:</b> Name + 1 shape + 1 vector for direction + 1 angle
  44 + 1 value (repetition) + 1 step value + 1 value (repetition).
  45
  46 <b>NB!</b> There is another way to execute a Double Multi-rotation
  47 operation, which is currently accessible only via TUI commands:
  48 <em>geompy.MakeMultiRotation2D(Shape, Dir, Point, Angle, nbtimes1, Step,nbtimes2)</em>
  49 which works in the same way,
  50 but the Axis is defined  by direction and point.
  51
  52 \image html neo-mrot2.png
  53
  54 \image html multi_rotation2d1.png "The initial object"
  55
  56 \image html multi_rotation2d2.png "The result of a double multi-rotation"
  57
  58 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  59 \ref tui_multi_rotation "Transformation Operations".
  60
  61 */