simgear/canvas/events/DeviceEvent.hxx

   1 ///@file
   2 /// Input device event (keyboard/mouse)
   3 //
   4 // Copyright (C) 2014  Thomas Geymayer <tomgey@gmail.com>
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Library General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2 of the License, or (at your option) any later version.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Library General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Library General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA
  19
  20 #ifndef CANVAS_DEVICE_EVENT_HXX_
  21 #define CANVAS_DEVICE_EVENT_HXX_
  22
  23 #include <simgear/canvas/CanvasEvent.hxx>
  24
  25 namespace osgGA { class GUIEventAdapter; }
  26
  27 namespace simgear
  28 {
  29 namespace canvas
  30 {
  31
  32   /**
  33    * Common interface for input device events.
  34    */
  35   class DeviceEvent:
  36     public Event
  37   {
  38     public:
  39       /// Default initialization (no active keyboard modifier).
  40       DeviceEvent();
  41
  42       /// Initialize from an OpenSceneGraph event.
  43       DeviceEvent(const osgGA::GUIEventAdapter& ea);
  44
  45       /// Get mask of active keyboard modifiers at the time of the event.
  46       int getModifiers() const { return modifiers; }
  47
  48       /// Get if a Ctrl modifier was active.
  49       bool ctrlKey() const;
  50
  51       /// Get if a Shift modifier was active.
  52       bool shiftKey() const;
  53
  54       /// Get if an Alt modifier was active.
  55       bool altKey() const;
  56
  57       /// Get if a Meta modifier was active.
  58       bool metaKey() const;
  59
  60     protected:
  61       int modifiers;  //!< Keyboard modifier state
  62   };
  63
  64 } // namespace canvas
  65 } // namespace simgear
  66
  67 #endif /* CANVAS_DEVICE_EVENT_HXX_ */