src/Main/fg_os.hxx

   1 #ifndef _FG_OS_HXX
   2 #define _FG_OS_HXX
   3
   4 #ifdef HAVE_CONFIG_H
   5 #  include <config.h>
   6 #endif
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include <osg/ref_ptr>
  12 #include <osg/Camera>
  13 #include <osg/GraphicsContext>
  14
  15
  16 enum { MOUSE_BUTTON_LEFT,
  17        MOUSE_BUTTON_MIDDLE,
  18        MOUSE_BUTTON_RIGHT };
  19
  20 enum { MOUSE_BUTTON_DOWN,
  21        MOUSE_BUTTON_UP };
  22
  23 enum { MOUSE_CURSOR_NONE,
  24        MOUSE_CURSOR_POINTER,
  25        MOUSE_CURSOR_WAIT,
  26        MOUSE_CURSOR_CROSSHAIR,
  27        MOUSE_CURSOR_LEFTRIGHT };
  28
  29 enum { KEYMOD_NONE     = 0,
  30        KEYMOD_RELEASED = 1, // Not a mod key, indicates "up" action
  31        KEYMOD_SHIFT    = 2,
  32        KEYMOD_CTRL     = 4,
  33        KEYMOD_ALT      = 8,
  34        KEYMOD_META     = 16,
  35        KEYMOD_SUPER    = 32,
  36        KEYMOD_HYPER    = 64,
  37        KEYMOD_MAX      = 128 };
  38
  39 // A note on key codes: none are defined here.  FlightGear has no
  40 // hard-coded interpretations of codes other than modifier keys, so we
  41 // can get away with that.  The only firm requirement is that the
  42 // codes passed to the fgKeyHandler function be correctly interpreted
  43 // by the PUI library.  Users who need to hard-code key codes
  44 // (probably not a good idea in any case) can use the pu.hxx header
  45 // for definitions.
  46
  47 //
  48 // OS integration functions
  49 //
  50
  51 void fgOSInit(int* argc, char** argv);
  52 void fgOSOpenWindow(bool stencil);
  53 void fgOSFullScreen();
  54 void fgOSMainLoop();
  55 void fgOSExit(int code);
  56
  57 void fgSetMouseCursor(int cursor);
  58 int  fgGetMouseCursor();
  59 void fgWarpMouse(int x, int y);
  60
  61 int  fgGetKeyModifiers();
  62
  63 void fgRequestRedraw();
  64
  65 //
  66 // Callbacks and registration API
  67 //
  68
  69 namespace osg { class Camera; class GraphicsContext; }
  70 namespace osgGA { class GUIEventAdapter; }
  71
  72 typedef void (*fgIdleHandler)();
  73 typedef void (*fgDrawHandler)();
  74 typedef void (*fgWindowResizeHandler)(int w, int h);
  75
  76 typedef void (*fgKeyHandler)(int key, int keymod, int mousex, int mousey);
  77 typedef void (*fgMouseClickHandler)(int button, int updown, int x, int y, bool mainWindow, const osgGA::GUIEventAdapter*);
  78 typedef void (*fgMouseMotionHandler)(int x, int y);
  79
  80 void fgRegisterIdleHandler(fgIdleHandler func);
  81 void fgRegisterDrawHandler(fgDrawHandler func);
  82 void fgRegisterWindowResizeHandler(fgWindowResizeHandler func);
  83
  84 void fgRegisterKeyHandler(fgKeyHandler func);
  85 void fgRegisterMouseClickHandler(fgMouseClickHandler func);
  86 void fgRegisterMouseMotionHandler(fgMouseMotionHandler func);
  87 #endif // _FG_OS_HXX