5 #include <osg/GraphicsContext>
7 #include <osg/Viewport>
8 #include <osgViewer/Viewer>
11 #include <Main/fg_props.hxx>
12 #include "CameraGroup.hxx"
13 #include "FGEventHandler.hxx"
14 #include "WindowSystemAdapter.hxx"
15 #include "renderer.hxx"
17 #if !defined(X_DISPLAY_MISSING)
18 #define X_DOUBLE_SCROLL_BUG 1
22 // hack - during interactive resize on Mac, OSG queues and then flushes
23 // a large number of resize events, without doing any drawing.
24 extern void puCleanUpJunk ( void ) ;
29 const int displayStatsKey = 1;
30 const int printStatsKey = 2;
33 // The manipulator is responsible for updating a Viewer's camera. Its
34 // event handling method is also a convenient place to run the FG idle
37 FGEventHandler::FGEventHandler() :
41 mouseMotionHandler(0),
42 statsHandler(new osgViewer::StatsHandler),
43 statsEvent(new osgGA::GUIEventAdapter),
44 statsType(osgViewer::StatsHandler::NO_STATS),
48 scrollButtonPressed(false)
50 using namespace osgGA;
51 statsHandler->setKeyEventTogglesOnScreenStats(displayStatsKey);
52 statsHandler->setKeyEventPrintsOutStats(printStatsKey);
53 statsEvent->setEventType(GUIEventAdapter::KEYDOWN);
55 // OSG reports NumPad keycodes independent of the NumLock modifier.
56 // Both KP-4 and KP-Left are reported as KEY_KP_Left (0xff96), so we
57 // have to generate the locked keys ourselves.
58 numlockKeyMap[GUIEventAdapter::KEY_KP_Insert] = '0';
59 numlockKeyMap[GUIEventAdapter::KEY_KP_End] = '1';
60 numlockKeyMap[GUIEventAdapter::KEY_KP_Down] = '2';
61 numlockKeyMap[GUIEventAdapter::KEY_KP_Page_Down] = '3';
62 numlockKeyMap[GUIEventAdapter::KEY_KP_Left] = '4';
63 numlockKeyMap[GUIEventAdapter::KEY_KP_Begin] = '5';
64 numlockKeyMap[GUIEventAdapter::KEY_KP_Right] = '6';
65 numlockKeyMap[GUIEventAdapter::KEY_KP_Home] = '7';
66 numlockKeyMap[GUIEventAdapter::KEY_KP_Up] = '8';
67 numlockKeyMap[GUIEventAdapter::KEY_KP_Page_Up] = '9';
68 numlockKeyMap[GUIEventAdapter::KEY_KP_Delete] = '.';
70 // mapping when NumLock is off
71 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Insert] = PU_KEY_INSERT;
72 noNumlockKeyMap[GUIEventAdapter::KEY_KP_End] = PU_KEY_END;
73 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Down] = PU_KEY_DOWN;
74 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Page_Down] = PU_KEY_PAGE_DOWN;
75 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Left] = PU_KEY_LEFT;
76 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Begin] = '5';
77 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Right] = PU_KEY_RIGHT;
78 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Home] = PU_KEY_HOME;
79 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Up] = PU_KEY_UP;
80 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Page_Up] = PU_KEY_PAGE_UP;
81 noNumlockKeyMap[GUIEventAdapter::KEY_KP_Delete] = 127;
83 for (int i = 0; i < 128; i++)
89 // Translate OSG modifier mask to FG modifier mask.
90 int osgToFGModifiers(int modifiers)
93 if (modifiers & osgGA::GUIEventAdapter::MODKEY_SHIFT)
94 result |= KEYMOD_SHIFT;
96 if (modifiers & osgGA::GUIEventAdapter::MODKEY_CTRL)
97 result |= KEYMOD_CTRL;
99 if (modifiers & osgGA::GUIEventAdapter::MODKEY_ALT)
100 result |= KEYMOD_ALT;
102 if (modifiers & osgGA::GUIEventAdapter::MODKEY_META)
103 result |= KEYMOD_META;
105 if (modifiers & osgGA::GUIEventAdapter::MODKEY_SUPER)
106 result |= KEYMOD_SUPER;
108 if (modifiers & osgGA::GUIEventAdapter::MODKEY_HYPER)
109 result |= KEYMOD_HYPER;
115 void FGEventHandler::init(const osgGA::GUIEventAdapter& ea,
116 osgGA::GUIActionAdapter& us)
118 currentModifiers = osgToFGModifiers(ea.getModKeyMask());
119 (void)handle(ea, us);
123 // Calculate event coordinates in the viewport of the GUI camera, if
124 // possible. Otherwise return false and (-1, -1).
128 eventToViewport(const osgGA::GUIEventAdapter& ea, osgGA::GUIActionAdapter& us,
134 const osg::GraphicsContext* eventGC = ea.getGraphicsContext();
135 const osg::GraphicsContext::Traits* traits = eventGC->getTraits();
136 osg::Camera* guiCamera = getGUICamera(CameraGroup::getDefault());
139 osg::Viewport* vport = guiCamera->getViewport();
143 // Scale x, y to the dimensions of the window
144 double wx = (((ea.getX() - ea.getXmin()) / (ea.getXmax() - ea.getXmin()))
145 * (float)traits->width);
146 double wy = (((ea.getY() - ea.getYmin()) / (ea.getYmax() - ea.getYmin()))
147 * (float)traits->height);
148 if (vport->x() <= wx && wx <= vport->x() + vport->width()
149 && vport->y() <= wy && wy <= vport->y() + vport->height()) {
150 // Finally, into viewport coordinates. Change y to "increasing
153 y = vport->height() - (wy - vport->y());
161 bool FGEventHandler::handle(const osgGA::GUIEventAdapter& ea,
162 osgGA::GUIActionAdapter& us)
167 switch (ea.getEventType()) {
168 case osgGA::GUIEventAdapter::FRAME:
172 case osgGA::GUIEventAdapter::KEYDOWN:
173 case osgGA::GUIEventAdapter::KEYUP:
176 handleKey(ea, key, modmask);
177 eventToViewport(ea, us, x, y);
179 (*keyHandler)(key, modmask, x, y);
182 case osgGA::GUIEventAdapter::PUSH:
183 case osgGA::GUIEventAdapter::RELEASE:
185 bool mainWindow = eventToViewport(ea, us, x, y);
187 switch (ea.getButton()) {
188 case osgGA::GUIEventAdapter::LEFT_MOUSE_BUTTON:
191 case osgGA::GUIEventAdapter::MIDDLE_MOUSE_BUTTON:
194 case osgGA::GUIEventAdapter::RIGHT_MOUSE_BUTTON:
198 if (mouseClickHandler)
199 (*mouseClickHandler)(button,
201 == osgGA::GUIEventAdapter::RELEASE), x, y, mainWindow, &ea);
204 case osgGA::GUIEventAdapter::SCROLL:
206 bool mainWindow = eventToViewport(ea, us, x, y);
207 #ifdef X_DOUBLE_SCROLL_BUG
208 scrollButtonPressed = !scrollButtonPressed;
209 if (!scrollButtonPressed) // Drop the button release event
213 if (ea.getScrollingMotion() == osgGA::GUIEventAdapter::SCROLL_2D) {
214 if (ea.getScrollingDeltaY() > 0)
216 else if (ea.getScrollingDeltaY() < 0)
220 } else if (ea.getScrollingMotion() == osgGA::GUIEventAdapter::SCROLL_UP)
224 if (mouseClickHandler && button != -1) {
225 (*mouseClickHandler)(button, 0, x, y, mainWindow, &ea);
226 (*mouseClickHandler)(button, 1, x, y, mainWindow, &ea);
230 case osgGA::GUIEventAdapter::MOVE:
231 case osgGA::GUIEventAdapter::DRAG:
232 // If we warped the mouse, then disregard all pointer motion
233 // events for this frame. We really want to flush the event
234 // queue of mouse events, but don't have the ability to do
235 // that with osgViewer.
238 if (eventToViewport(ea, us, x, y) && mouseMotionHandler)
239 (*mouseMotionHandler)(x, y);
241 case osgGA::GUIEventAdapter::RESIZE:
242 CameraGroup::getDefault()->resized();
244 globals->get_renderer()->resize(ea.getWindowWidth(), ea.getWindowHeight());
246 // work around OSG Cocoa-Viewer issue with resize event handling,
247 // where resize events are queued up, then dispatched in a batch, with
248 // no interveningd drawing calls.
252 case osgGA::GUIEventAdapter::CLOSE_WINDOW:
253 case osgGA::GUIEventAdapter::QUIT_APPLICATION:
261 void FGEventHandler::handleKey(const osgGA::GUIEventAdapter& ea, int& key,
264 using namespace osgGA;
266 // XXX Probably other translations are needed too.
268 case GUIEventAdapter::KEY_Escape: key = 0x1b; break;
269 case GUIEventAdapter::KEY_Return: key = '\n'; break;
270 case GUIEventAdapter::KEY_BackSpace: key = '\b'; break;
271 case GUIEventAdapter::KEY_Delete: key = 0x7f; break;
272 case GUIEventAdapter::KEY_Tab: key = '\t'; break;
273 case GUIEventAdapter::KEY_Left: key = PU_KEY_LEFT; break;
274 case GUIEventAdapter::KEY_Up: key = PU_KEY_UP; break;
275 case GUIEventAdapter::KEY_Right: key = PU_KEY_RIGHT; break;
276 case GUIEventAdapter::KEY_Down: key = PU_KEY_DOWN; break;
277 case GUIEventAdapter::KEY_Page_Up: key = PU_KEY_PAGE_UP; break;
278 case GUIEventAdapter::KEY_Page_Down: key = PU_KEY_PAGE_DOWN; break;
279 case GUIEventAdapter::KEY_Home: key = PU_KEY_HOME; break;
280 case GUIEventAdapter::KEY_End: key = PU_KEY_END; break;
281 case GUIEventAdapter::KEY_Insert: key = PU_KEY_INSERT; break;
282 case GUIEventAdapter::KEY_F1: key = PU_KEY_F1; break;
283 case GUIEventAdapter::KEY_F2: key = PU_KEY_F2; break;
284 case GUIEventAdapter::KEY_F3: key = PU_KEY_F3; break;
285 case GUIEventAdapter::KEY_F4: key = PU_KEY_F4; break;
286 case GUIEventAdapter::KEY_F5: key = PU_KEY_F5; break;
287 case GUIEventAdapter::KEY_F6: key = PU_KEY_F6; break;
288 case GUIEventAdapter::KEY_F7: key = PU_KEY_F7; break;
289 case GUIEventAdapter::KEY_F8: key = PU_KEY_F8; break;
290 case GUIEventAdapter::KEY_F9: key = PU_KEY_F9; break;
291 case GUIEventAdapter::KEY_F10: key = PU_KEY_F10; break;
292 case GUIEventAdapter::KEY_F11: key = PU_KEY_F11; break;
293 case GUIEventAdapter::KEY_F12: key = PU_KEY_F12; break;
294 case GUIEventAdapter::KEY_KP_Enter: key = '\r'; break;
295 case GUIEventAdapter::KEY_KP_Add: key = '+'; break;
296 case GUIEventAdapter::KEY_KP_Divide: key = '/'; break;
297 case GUIEventAdapter::KEY_KP_Multiply: key = '*'; break;
298 case GUIEventAdapter::KEY_KP_Subtract: key = '-'; break;
300 osgGA::GUIEventAdapter::EventType eventType = ea.getEventType();
303 // Num Lock is always true on Mac
304 std::map<int, int>::iterator numPadIter = numlockKeyMap.find(key);
305 if (numPadIter != numlockKeyMap.end()) {
306 key = numPadIter->second;
309 if (ea.getModKeyMask() & osgGA::GUIEventAdapter::MODKEY_NUM_LOCK)
311 // NumLock on: map to numeric keys
312 std::map<int, int>::iterator numPadIter = numlockKeyMap.find(key);
313 if (numPadIter != numlockKeyMap.end()) {
314 key = numPadIter->second;
319 // NumLock off: map to PU arrow keys
320 std::map<int, int>::iterator numPadIter = noNumlockKeyMap.find(key);
321 if (numPadIter != noNumlockKeyMap.end()) {
322 key = numPadIter->second;
327 modifiers = osgToFGModifiers(ea.getModKeyMask());
328 currentModifiers = modifiers;
329 if (eventType == osgGA::GUIEventAdapter::KEYUP)
330 modifiers |= KEYMOD_RELEASED;
332 // Release the letter key, for which the key press was reported. This
333 // is to deal with Ctrl-press -> a-press -> Ctrl-release -> a-release
335 if (key >= 0 && key < 128) {
336 if (modifiers & KEYMOD_RELEASED) {
337 key = release_keys[key];
339 release_keys[key] = key;
340 if (key >= 1 && key <= 26) {
341 release_keys[key + '@'] = key;
342 release_keys[key + '`'] = key;
343 } else if (key >= 'A' && key <= 'Z') {
344 release_keys[key - '@'] = key;
345 release_keys[tolower(key)] = key;
346 } else if (key >= 'a' && key <= 'z') {
347 release_keys[key - '`'] = key;
348 release_keys[toupper(key)] = key;
354 void FGEventHandler::handleStats(osgGA::GUIActionAdapter& us)
356 static SGPropertyNode_ptr display = fgGetNode("/sim/rendering/on-screen-statistics", true);
357 static SGPropertyNode_ptr print = fgGetNode("/sim/rendering/print-statistics", true);
359 int type = display->getIntValue() % osgViewer::StatsHandler::LAST;
360 if (type != statsType) {
361 statsEvent->setKey(displayStatsKey);
363 statsType = (statsType + 1) % osgViewer::StatsHandler::LAST;
364 statsHandler->handle(*statsEvent, us);
365 } while (statsType != type);
367 display->setIntValue(statsType);
370 if (print->getBoolValue()) {
371 statsEvent->setKey(printStatsKey);
372 statsHandler->handle(*statsEvent, us);
373 print->setBoolValue(false);
377 void eventToWindowCoords(const osgGA::GUIEventAdapter* ea,
378 double& x, double& y)
381 const GraphicsContext* gc = ea->getGraphicsContext();
382 const GraphicsContext::Traits* traits = gc->getTraits() ;
383 // Scale x, y to the dimensions of the window
384 x = (((ea->getX() - ea->getXmin()) / (ea->getXmax() - ea->getXmin()))
385 * (double)traits->width);
386 y = (((ea->getY() - ea->getYmin()) / (ea->getYmax() - ea->getYmin()))
387 * (double)traits->height);
388 if (ea->getMouseYOrientation() == osgGA::GUIEventAdapter::Y_INCREASING_DOWNWARDS)
389 y = (double)traits->height - y;
392 void eventToWindowCoordsYDown(const osgGA::GUIEventAdapter* ea,
393 double& x, double& y)
396 const GraphicsContext* gc = ea->getGraphicsContext();
397 const GraphicsContext::Traits* traits = gc->getTraits() ;
398 // Scale x, y to the dimensions of the window
399 x = (((ea->getX() - ea->getXmin()) / (ea->getXmax() - ea->getXmin()))
400 * (double)traits->width);
401 y = (((ea->getY() - ea->getYmin()) / (ea->getYmax() - ea->getYmin()))
402 * (double)traits->height);
403 if (ea->getMouseYOrientation() == osgGA::GUIEventAdapter::Y_INCREASING_UPWARDS)
404 y = (double)traits->height - y;