manipulator.docu 4.27 KB
Newer Older
Matthias Möller's avatar
Matthias Möller committed
1
/** \page manipulator Manipulator
2 3
 * 
 * \image html manipulator/manipulator.png
Matthias Möller's avatar
Matthias Möller committed
4 5 6
 * 
 * The Manipulator is an easy to use tool for translation, rotation, and resizing.
 * 
7
 * It is used by several Plugins e.g. the <a href="../Plugin-Move/index.html"><b>Move Plugin</b></a>.
Matthias Möller's avatar
Matthias Möller committed
8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
 * 
 * \section Summary
 * \ref obj_man
 * \li \ref obj_translation
 * \li \ref obj_rotation
 * \li \ref obj_resizing
 * 
 * \ref property_window
 * 
 * \ref man_man 
 * \li \ref man_translation
 * \li \ref man_rotation
 * \li \ref man_resizing
 * 
 * \note Not every plugin provide all manipulations presented in this document
 * 
 * \section obj_man Object Manipulation
 * Before you can start, you have to place the manipulator and bind it to an object.
 * A <b>double left click</b> on the desired object resolves this problem.
 * If you want to change the manipulated object, <b>double left click</b>
 * on the desired place again.
 * After placing the manipulator, you can proceed with the following manipulations.
30
 * \note Use the <a href="../Plugin-Datacontrol/index.html"><b>Data Control Plugin</b></a> to select multiple objects as targets.
Matthias Möller's avatar
Matthias Möller committed
31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48
 * 
 * 
 * \subsection obj_translation Object Translation
 * The translation can be done via the arrow tails or the ball in the center.
 * 
 * \image html manipulator/manipulator_trans_rot_describe.png "The Manipulator for Rotation and Translation"
 * 
 * Click on the ball, hold and move the to translate an object
 * to all directions. If the directions should be limited, click
 * on an arrow tail. Now, you can move your mouse, but the object
 * will only be translated on the 1D axis described by the arrow.
 * 
 * \subsection obj_rotation Object Rotation
 * The Manipulator in resize mode
 * By clicking on one of the circles around the manipulator or 
 * on one of the arrow tips (See image in \ref obj_translation),
 * you can rotate the object.
 * After clicking with the mouse button,hold it and move the mouse, to rotate the object.
Jan Möbius's avatar
Jan Möbius committed
49
 * The rotation axis is the arrow tail of the clicked arrow tip, or the arrow tail which is circle by the pressed circle.
Matthias Möller's avatar
Matthias Möller committed
50
 * 
51
 * 
Matthias Möller's avatar
Matthias Möller committed
52 53 54 55 56
 * \subsection obj_resizing Object Resizing
 * 
 * \image html manipulator/manipulator_resize_describe.png "The Manipulator in resize mode"
 * 
 * First, enable the "resize" mode by pressing and holding the <b>\<Control></b> key or pressing the button shown below.
57 58
 * You will see, the circles around the manipulator vanished and the arrows have two tips.
 * 
Matthias Möller's avatar
Matthias Möller committed
59 60 61 62 63 64 65 66 67
 * 
 * \image html manipulator/manipulator_resize.png "Button enables the \"resize\" mode"
 * 
 * Now you can resize the object by pressing on one of the arrows, holding and moving
 * the mouse. This procedure resizes the object in the arrow direction.\n
 * It is also possible to resize the object an all dimensions.
 * Click on the ball center for doing this. 
 * 
 * \section property_window Property Window
68 69 70
 * The Property Window is provided by the <a href="../Plugin-Move/index.html#property_window"><b>Move Plugin</b></a>.
 * Please read the linked article for more information.
 * However, the Property Window can be used with other Plugins. 
Matthias Möller's avatar
Matthias Möller committed
71 72 73 74 75 76 77 78
 * 
 * \section man_man Manipulator Manipulation
 * The following manipulations manipulates the Manipulator itself. So, no data of your mesh will
 * be harmed.
 * 
 * \subsection man_translation Manipulator Translation
 * \image html manipulator/manipulator_manip_translation.png "Button enables the \"Locally translate manipulator\" mode"
 * 
Jan Möbius's avatar
Jan Möbius committed
79
 * To translate the Manipulator, enable the "Locally translate manipulator" mode.
Matthias Möller's avatar
Matthias Möller committed
80 81 82 83 84 85 86 87 88 89 90 91 92
 * This can be done by pressing the button shown above.
 * The manipulator follows the mouse. Click with the mouse button to set the manipulator
 * on the desired place.
 * \note There are no existing shortcuts to enable this mode 
 * 
 * 
 * \subsection man_rotation Manipulator Rotation
 * \image html manipulator/manipulator_manip_rotate.png "Button enables \"Rotate manipulator\" mode"
 * 
 * The Manipulator can be rotated. For doing this,
 * enable in the "Rotate manipulator" mode by pressing the button shown above,
 * or by pressing and holding the <b>\<Shift\></b> key.
 * Now, the Manipulator can be rotated as a normal object.
93
 * For doing this, see \ref obj_rotation. 
Matthias Möller's avatar
Matthias Möller committed
94 95 96 97 98
 * 
 * \subsection man_resizing Manipulator Resizing
 * Use the <b>mousewheel \<up></b>and <b>mousewheel \<down\></b> to resize the manipulator.
 */