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 rotated shapes basing on the initial shape.
   9
  10
  11 In case of  <b>Simple Multi Rotation</b> the object is multiplied by rotation.
  12
  13 \image html neo-mrot1.png
  14
  15 The following parameters and options can be defined in this dialog:
  16 - <b>Result Name</b>;
  17 - <b> Main Object </b> to be rotated;
  18 - \b Vector defines the axis of rotation (DZ by default);
  19 - <b>Angular step</b> is the angle by which the object is rotated. By default
  20 (if the checkbox is not checked), it is 2 * \a PI / \a NbTimes;
  21 - <b>Nb. Times</b> is the number of rotated shape copies in the resulting compound. If \a NbTimes = 1, the result contains only the
  22 initial shape;
  23 - \ref restore_presentation_parameters_page "Advanced options".
  24
  25 \n The \b Result will be a \b GEOM_Object (compound).
  26
  27 \n <b>TUI Commands:</b>
  28 \n <em>geompy.MultiRotate1DNbTimes(Shape, Axis, NbTimes)</em>
  29 \n <em>geompy.MultiRotate1DByStep(Shape, Axis, AngleStep, NbTimes)</em>
  30
  31 \b <b>NB!</b> There is another way to execute a Multi-rotation
  32 operation, which is currently accessible only via TUI commands:
  33 <em>geompy.MakeMultiRotation1DNbTimes(Shape, Dir, Point, NbTimes)</em>,
  34 <em>geompy.MakeMultiRotation1DByStep(Shape, Dir, Point, AngleStep, NbTimes)</em>,
  35 which works in the same way, but the Axis is defined by direction and point.
  36
  37 \image html multi_rotation1d1.png "The initial object"
  38
  39 \image html multi_rotation1d2.png "The result of a simple multi-rotation"
  40
  41 In case of  <b>Double Multi Rotation</b> the object is multiplied by rotation and additionally translated several times in each direction.
  42
  43 \image html neo-mrot2.png
  44
  45 The following parameters and options can be defined in this dialog:
  46 - <b>Result Name</b>;
  47 - <b> Main Object </b> to be rotated;
  48 - \b Vector defines the axis of rotation (DZ by default);
  49 - <b>Angular step</b> is the angle by which the object is rotated. By default
  50 (if the checkbox is not checked), it is 2 * \a PI / \a NbTimes;
  51 - <b>Nb. Times</b> (\a NbTimes1) is the number of rotated shape copies in the resulting compound;
  52 - \b Reverse checkbox allows changing the direction of translation;
  53 - <b> Radial step </b> is the distance between the shape copies in the same direction. Translation direction passes through the center of gravity of the
  54 initial shape and its projection on the rotation axis;
  55 - <b>Nb. Times</b> (\a NbTimes2) is the number of shape copies in the same direction. If \a NbTimes2 = 1, the result is the same as for <b>Simple Multi Rotation</b>. If both \a NbTimes1 and \a NbTimes2 are equal to 1, the result will contain only the initial non-transformed shape;
  56 - \ref restore_presentation_parameters_page "Advanced options".
  57
  58 \n <b>TUI Commands:</b>
  59 \n <em>geompy.MultiRotate2DNbTimes(Shape, Axis, NbTimes1, RadialStep, NbTimes2)</em>
  60 \n <em>geompy.MultiRotate2DByStep(Shape, Axis, AngleStep, NbTimes1, RadialStep, NbTimes2)</em>
  61
  62 <b>NB!</b> There is another way to execute a Double Multi-rotation
  63 operation, which is currently accessible only via TUI commands:
  64 <em>geompy.MakeMultiRotation2DNbTimes(Shape, Dir, Point, NbTimes1, RadialStep, NbTimes2)</em>,
  65 <em>geompy.MakeMultiRotation2DByStep(Shape, Dir, Point, AngleStep, NbTimes1, RadialStep, NbTimes2)</em>,
  66 which works in the same way, but the Axis is defined by direction and point.
  67
  68
  69 \image html multi_rotation2d1.png "The initial object"
  70
  71 \image html multi_rotation2d2.png "The result of a double multi-rotation"
  72
  73 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  74 \ref tui_multi_rotation "Transformation Operations".
  75
  76 */