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>TUI Command:</b> <em>geompy.MakeRotation(Shape, Axis, Angle)</em>
  13 \n <b>Arguments:</b> Name + one or several objects + 1 vector for direction of rotation + 1
  14 angle.
  15
  16 \image html transformation4.png
  17
  18 \b Reverse checkbox allows to specify the direction of rotation.
  19 \n <b>Create a copy</b> checkbox allows to keep the initial object,
  20 otherwise it will be removed.
  21 \n The \b Result will be any \b GEOM_Object.
  22
  23 \n The second algorithm allows to define the rotated \b Object by
  24 three points. Rotation axis will pass through the <b>Central Point</b>
  25 and will be will be orthogonal to a plane defned by three points. In
  26 this case rotation \b Angle is the angle between two vectors directed
  27 from the first point to the second and to the third.
  28 \n <b>TUI Command:</b> <em>geompy.MakeRotationThreePoints(Shape, CentralPoint, Point1, Point2)</em>
  29 \n <b>Arguments:</b> 1 shape + 3 points.
  30
  31 \image html transformation4a.png
  32
  33 \n <b>Example:</b>
  34
  35 \image html rotationsn1.png
  36
  37 \image html rotationsn2.png
  38
  39 Our <b>TUI Scripts</b> provide you with useful examples of the use of
  40 \ref tui_rotation "Transformation Operations".
  41
  42 */