1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>libQGLViewer mouse behavior</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<link href="qglviewer.css" rel="stylesheet" type="text/css" />
<link rel="shortcut icon" href="images/qglviewer.ico" type="image/x-icon" />
<link rel="icon" href="images/qglviewer.icon.png" type="image/png" />
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23223012-2']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div class="banner">
<a class="qindex highlight" href="index.html">Home</a>
<a class="qindex" href="download.html">Download</a>
<a class="qindex" href="examples/index.html">Gallery</a>
<a class="qindex" href="refManual/hierarchy.html">Documentation</a>
<a class="qindex" href="developer.html">Developer</a>
</div>
<h1>Mouse binding customization</h1>
<h2>Principles</h2>
A mouse click can either perform a given atomic <i>click action</i> (such as selecting an object) or can be
the initiation of a <i>mouse action</i> (such as moving the camera). This action is then transmitted to
the <code>camera()</code>, the <code>manipulatedFrame()</code> or the <code>mouseGrabber()</code>.
<p>
The actual behavior is entirely customizable: the <code>ClickAction</code> (triggered when you
click) and the <code>MouseAction</code> (activated when you click then drag) can be binded to any
mouse button(s) with any <code>Control, Alt, Shift</code> modifier key combination.
</p>
<p>
Default bindings are described below. To sum up, the <code>camera()</code> is the default mouse event
receiver while the <code>manipulatedFrame()</code> is used when the <code>Ctrl</code> key is pressed.
<br/>
The <code>MouseGrabber</code> is specific since its behavior entirely depends on your
implementation. See the <a href="refManual/classqglviewer_1_1MouseGrabber.html">MouseGrabber
documentation</a> for details.
</p>
<h2>Customizing your mouse binding</h2>
The following functions are illustrated in the <a href="examples/keyboardAndMouse.html">keyboardAndMouse</a> example.
<ul>
<li>
To bind a <code>ClickAction</code>, use <code>setMouseBinding(Qt::KeyboardModifiers, Qt::MouseButton, ClickAction,
doubleClick=false, buttonsBefore=Qt::NoButton)</code>:
<pre>
// Click on the right button to make a selection
setMouseBinding(Qt::NoModifier, Qt::RightButton, SELECT);
// Pressing the middle button, then double clicking the right button, while pressing Alt shows the entire scene. Cool huh ?
setMouseBinding(Qt::AltModifier, Qt::RightButton, SHOW_ENTIRE_SCENE, true, Qt::MidButton);
</pre>
</li>
<li>
To bind a <code>MouseAction</code>, use <code>setMouseBinding(Qt::KeyboardModifiers, Qt::MouseButton, MouseHandler,
MouseAction, withConstraint=true)</code> (same function name as above, but different parameters):
<pre>
// Control, Shift and Left buttons together make a camera zoom.
setMouseBinding(Qt::ControlModifier | Qt::ShiftModifier, Qt::LeftButton, CAMERA, ZOOM);
// Alt + Shift + Left button rotates the manipulatedFrame().
setMouseBinding(Qt::AltModifier | Qt::ShiftModifier, Qt::LeftButton, FRAME, ROTATE);
</pre>
</li>
<li>
And finally, for the mouse wheel associated action, use <code>setWheelBinding(Qt::KeyboardModifiers, MouseHandler, MouseAction, withConstraint=true)</code>:
<pre>
// Alt + wheel moves the camera forward.
setWheelBinding(Qt::ALT, CAMERA, MOVE_FORWARD);
</pre>
</li>
</ul>
<p>
The following tables list all the available <code>ClickAction</code> and <code>MouseAction</code> as
well as their default associated bindings. Note that the current bindings are always available in
the <code>Mouse</code> tab of the help window (press <code>H</code> for help).
</p>
On Mac OS X, following Qt's convention, the <code>Control</code> modifier corresponds to the command key, and <code>Meta</code> is the control key.
<center>
<h3>ClickAction bindings</h3>
<table bgcolor="#FFF" border="2" cellspacing="0" cellpadding="5">
<tr bgcolor="#DDE">
<td><code><b>ClickAction</b></code></td>
<td><b>Description</b></td>
<td><b>Default binding</b></td>
</tr>
<tr>
<td><code><b>ALIGN_CAMERA</b></code></td>
<td>Align the camera axis with the world coordinate system axis.</td>
<td>Double click left button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>ALIGN_FRAME</b></code></td>
<td>Align the <code>manipulatedFrame()</code> axis with the camera.</td>
<td>Control + double click left button</td>
</tr>
<tr>
<td><code><b>CENTER_FRAME</b></code></td>
<td>Translates the <code>manipulatedFrame()</code> to the center of the screen.</td>
<td>Control + double click right button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>CENTER_SCENE</b></code></td>
<td>Translates the camera so that the <code>sceneCenter</code> is in the center of the screen.</td>
<td>Double click right button</td>
</tr>
<tr>
<td><code><b>NO_CLICK_ACTION</b></code></td>
<td>No action, only used as a specific return value in <code>QGLViewer::clickAction()</code>.</td>
<td> </td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>SELECT</b></code></td>
<td>Calls the <code>QGLViewer::select()</code> function.</td>
<td>Shift + Left button</td>
</tr>
<tr>
<td><code><b>RAP_FROM_PIXEL</b></code></td>
<td>Set the camera <code>pivotPoint()</code> to the point under pixel.<br/>
If no point is found, resets the <code>pivotPoint()</code> to <code>sceneCenter</code> .</td>
<td>Shift + right button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>RAP_IS_CENTER</b></code></td>
<td>Makes the <code>sceneCenter</code> the new camera <code>pivotPoint()</code>.</td>
<td> </td>
</tr>
<tr>
<td><code><b>SHOW_ENTIRE_SCENE</b></code></td>
<td>Translates the camera so that the entire scene is visible.</td>
<td>Double click middle button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>ZOOM_ON_PIXEL</b></code></td>
<td>Makes the camera zoom on the pixel under the mouse (if any).</td>
<td>Z + left button</td>
</tr>
<tr>
<td><code><b>ZOOM_TO_FIT</b></code></td>
<td>Makes the camera zoom to see the entire scene.</td>
<td>Z + right button</td>
</tr>
</table>
<h3>MouseAction bindings</h3>
<table bgcolor="#FFF" border="2" cellspacing="0" cellpadding="5">
<tr bgcolor="#DDE">
<td><code><b>MouseAction</b></code></td>
<td><code><b>Handler</b></code></td>
<td><b>Description</b></td>
<td><b>Default binding</b></td>
</tr>
<tr>
<td><code><b>NO_MOUSE_ACTION</b></code></td>
<td> </td>
<td>No action, only used as a specific return value in <code>QGLViewer::mouseAction()</code>.</td>
<td> </td>
</tr>
<tr bgcolor="#EEF">
<td rowspan="2"><code><b>ROTATE</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Rotates the camera around its <code>pivotPoint()</code>.</td>
<td>Left button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>FRAME</b></code></td>
<td>Rotates the <code>manipulatedFrame()</code> around its origin.</td>
<td>Control + Left button</td>
</tr>
<tr>
<td rowspan="2"><code><b>ZOOM</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Makes the camera zoom in/out. Speed depends on distance to the scene center.</td>
<td>Middle button</td>
</tr>
<tr>
<td><code><b>FRAME</b></code></td>
<td>Makes the <code>manipulatedFrame()</code> move closer or further from the camera.</td>
<td>Control + Middle button</td>
</tr>
<tr bgcolor="#EEF">
<td rowspan="2"><code><b>TRANSLATE</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td rowspan="2">Translates in the camera XY plane.</td>
<td>Right button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>FRAME</b></code></td>
<td>Control + Right button</td>
</tr>
<tr>
<td><code><b>MOVE_FORWARD</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Makes the camera go forward at <code>flySpeed()</code> and view direction can be changed.</td>
<td> </td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>MOVE_BACKWARD</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Same as <code>MOVE_FORWARD</code> but backward.</td>
<td> </td>
</tr>
<tr>
<td><code><b>DRIVE</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Mouse up/down goes forward/backward proportionally to <code>flySpeed()</code> while left/right turns.</td>
<td> </td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>LOOK_AROUND</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Change the viewing direction. The camera position is not modified.</td>
<td> </td>
</tr>
<tr>
<td><code><b>ROLL</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Rolls camera according to horizontal mouse displacement.</td>
<td> </td>
</tr>
<tr bgcolor="#EEF">
<td rowspan="2"><code><b>SCREEN_ROTATE</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td rowspan="2">Rotates around an axis orthogonal to the screen.</td>
<td>R + left button</td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>FRAME</b></code></td>
<td>Control + R + left button</td>
</tr>
<tr>
<td rowspan="2"><code><b>SCREEN_TRANSLATE</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td rowspan="2">Translates purely horizontally or vertically wrt screen.</td>
<td> </td>
</tr>
<tr>
<td><code><b>FRAME</b></code></td>
<td> </td>
</tr>
<tr bgcolor="#EEF">
<td><code><b>ZOOM_ON_REGION</b></code></td>
<td><code><b>CAMERA</b></code></td>
<td>Draws a rectangular region on screen and zooms on it.</td>
<td>Shift + middle button</td>
</tr>
</table>
</center>
<p>
As you can see, the <code><b>CAMERA</b></code> and <code><b>FRAME</b></code> default bindings are essentially
identical: You simply have to press the <code>Control</code> keyboard modifier to move the
<code><b>FRAME</b></code> instead of the <code><b>CAMERA</b></code>. This modifier key can be
modified using <code>setHandlerKeyboardModifiers()</code>.
</p>
Also note that a double click basically automates the normal mouse action.
<p>
<code>MOVE_FORWARD</code>, <code>MOVE_BACKWARD</code>, <code>LOOK_AROUND</code> and
<code>ROLL</code> are specific to the <code><b>CAMERA</b></code> fly mode. Press <code>Space</code>
to switch between revolve and fly camera modes.
</p>
Try the <a href="examples/simpleViewer.html">simpleViewer</a> and <a
href="examples/manipulatedFrame.html">manipulatedFrame</a> examples for an illustration.
<a name="newBindings"></a>
<h2>Defining new mouse bindings</h2>
If you want to implement a new mouse behavior, simply overload the <code>mousePressEvent(),
mouseMoveEvent(), mouseDoubleClickEvent()</code> and <code>mouseReleaseEvent()</code> callback
methods in your <code>QGLViewer</code> derived class. See the
<code>QGLViewer::mouseMoveEvent()</code> documentation for details.
<p>
Use <code>QGLViewer::setMouseBindingDescription()</code> to add an entry in the help window
<code>Mouse</code> tab that describes your new mouse binding.
</p>
<p>
See the <a href="examples/keyboardAndMouse.html">keyboardAndMouse</a> example for a practical
implementation.
</p>
<p>
If you implemented a new mouse behavior and you think it can be useful for other applications, send
me an <a href="mailto:contact@libqglviewer.com">e-mail</a> and I will add it
in the standard list.
</p>
<p>
<a href="http://validator.w3.org/check/referer"><img src="images/xhtml.png" alt="Valid XHTML 1.0!" height="31" width="88"/></a>
<a href="http://jigsaw.w3.org/css-validator/check/referer"><img src="images/css.gif" alt="Valid CSS!" width="88" height="31"/></a>
<i>Last modified on Sunday, March 13, 2022.</i>
</p>
</body></html>
|
