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 a compound of several shapes rotated in one
   9 or two dimensions basing on the initial shape.
  10 \n The \b Result will be one \b GEOM_Object (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 (DZ by
  14 default), Angle of rotation (optionally) and a <b>Number of Times</b>
  15 the shape must be rotated. If <b>Angular step</b> is not defined
  16 (checkbox is not checked), it will be 2 * \a PI / \a NbTimes. Number
  17 of shape's copies in the resulting compound will be equal to
  18 \a NbTimes (if \a NbTimes = 1, the result will contain only the
  19 initial non-transformed shape).
  20
  21 \n <b>TUI Commands:</b>
  22 \n <em>geompy.MultiRotate1DNbTimes(Shape, Axis, NbTimes)</em>
  23 \n <em>geompy.MultiRotate1DByStep(Shape, Axis, AngleStep, NbTimes)</em>
  24
  25 \b <b>NB!</b> There is another way to execute a Multi-rotation
  26 operation, which is currently accessible only via TUI commands:
  27 <em>geompy.MakeMultiRotation1DNbTimes(Shape, Dir, Point, NbTimes)</em>,
  28 <em>geompy.MakeMultiRotation1DByStep(Shape, Dir, Point, AngleStep, NbTimes)</em>,
  29 which works in the same way, but the Axis is defined by direction and point.
  30
  31 \image html neo-mrot1.png
  32
  33 \image html multi_rotation1d1.png "The initial object"
  34
  35 \image html multi_rotation1d2.png "The result of a simple multi-rotation"
  36
  37 \n <b>Double Multi Rotation</b> (in two dimensions) rotates the given
  38 \b Object around the given \b Axis (DZ by default) on the given
  39 \b Angle (optional) a given <b>Number of Times</b> and
  40 multi-translates each rotation result.
  41 If <b>Angular step</b> is not defined (checkbox is not checked), it
  42 will be 2 * \a PI / \a NbTimes.
  43 Translation direction passes through the center of gravity of the
  44 initial shape and its projection on the rotation axis. Number of
  45 shape's copies in the resulting compound will be equal to \a NbTimes1 x \a NbTimes2
  46 (if both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain
  47 only the initial non-transformed shape).
  48 \b Reverse checkbox allows to set the direction of rotation.
  49
  50 \n <b>TUI Commands:</b>
  51 \n <em>geompy.MultiRotate2DNbTimes(Shape, Axis, NbTimes1, RadialStep, NbTimes2)</em>
  52 \n <em>geompy.MultiRotate2DByStep(Shape, Axis, AngleStep, NbTimes1, RadialStep, NbTimes2)</em>
  53
  54 <b>NB!</b> There is another way to execute a Double Multi-rotation
  55 operation, which is currently accessible only via TUI commands:
  56 <em>geompy.MakeMultiRotation2DNbTimes(Shape, Dir, Point, NbTimes1, RadialStep, NbTimes2)</em>,
  57 <em>geompy.MakeMultiRotation2DByStep(Shape, Dir, Point, AngleStep, NbTimes1, RadialStep, NbTimes2)</em>,
  58 which works in the same way, but the Axis is defined by direction and point.
  59
  60 \image html neo-mrot2.png
  61
  62 \image html multi_rotation2d1.png "The initial object"
  63
  64 \image html multi_rotation2d2.png "The result of a double multi-rotation"
  65
  66 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  67 \ref tui_multi_rotation "Transformation Operations".
  68
  69 */