doc/salome/gui/GEOM/input/rotation_operation.doc

   1 /*!
   2
   3 \page rotation_operation_page Rotation
   4
   5 \n To produce a \b Rotation in the <b>Main Menu</b> select
   6 <b>Operations - > Transformation - > Rotation</b>
   7
   8 \n This operation \b rotates the initial shape.
   9
  10 \n The first \b Rotation algorithm needs you to define an \b Object to
  11 be rotated, an \b Axis of rotation and an \b Angle of rotation.
  12 \n \b Reverse checkbox allows to specify the direction of rotation.
  13 \n <b>Create a copy</b> checkbox allows to keep the initial object,
  14 otherwise it will be removed.
  15 \n \ref restore_presentation_parameters_page "Advanced options".
  16
  17 \image html transformation4.png
  18
  19 \n <b>TUI Command:</b> <em>geompy.MakeRotation(Shape, Axis, Angle)</em>
  20 \n <b>Arguments:</b> Name + one or several objects + 1 vector for direction of rotation + 1 angle.
  21
  22 \n The second algorithm allows to define the rotated \b Object by
  23 three points. Rotation axis will pass through the <b>Central Point</b>
  24 and will be will be orthogonal to a plane defned by three points. In
  25 this case rotation \b Angle is the angle between two vectors directed
  26 from the  <b>Central Point</b> to \b Point1 and \b Point2.
  27 \n \b Reverse checkbox allows to specify the direction of rotation.
  28 \n <b>Create a copy</b> checkbox allows to keep the initial object,
  29 otherwise it will be removed.
  30 \n \ref restore_presentation_parameters_page "Advanced options".
  31
  32 \image html transformation4a.png
  33
  34 \n <b>TUI Command:</b> <em>geompy.MakeRotationThreePoints(Shape, CentralPoint, Point1, Point2)</em>
  35 \n <b>Arguments:</b> 1 shape + 3 points.
  36
  37
  38 \n <b>Example:</b>
  39
  40 \image html rotationsn1.png "The initial shape (yellow)"
  41
  42 \image html rotationsn2.png "The rotated shape (grey)"
  43
  44 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  45 \ref tui_rotation "Transformation Operations".
  46
  47 */