src/keyboardEventHandler.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2007 by                                                 *
 *         Pierre-yves JEZEQUEL, Julien MICHOT, Loic MOISAN,               *
 *         Julien PAPILLON, Sebastien PINEAUD, Barthelemy SERRES           *
 *                                                                         *
 *   https://sourceforge.net/projects/anidam                               *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program is distributed in the hope that it will be useful,       *
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
 *   GNU General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
#ifndef KEYBOARD_HANDLER_H
#define KEYBOARD_HANDLER_H
#include <osgGA/GUIEventHandler> 


class keyboardEventHandler : public osgGA::GUIEventHandler
{
public:

   typedef void (*functionType) ();
   enum keyStatusType
   {
      KEY_UP, KEY_DOWN 
   };

   // A struct for storing current status of each key and 
   // function to execute. Keep track of key's state to avoid
   // redundant calls. (If the key is already down, don't call the
   // key down method again.)
   struct functionStatusType
   {
      functionStatusType() {keyState = KEY_UP; keyFunction = NULL;}
      functionType keyFunction;
      keyStatusType keyState;
   };

   // Storage for list of registered key, function to execute and 
   // current state of key.
   typedef std::map<int, functionStatusType > keyFunctionMap;

   // Function to associate a key with a function. If the key has not
   // been previously registered, key and function are added to the
   // map of 'key down' events and 'true' is returned. Otherwise, no
   // entry made and false is returned.
   bool addFunction(int whatKey, functionType newFunction);

   // Overloded version allows users to specify if the function should 
   // be associated with KEY_UP or KEY_DOWN event.
   bool addFunction(int whatKey, keyStatusType keyPressStatus, 
                                         functionType newFunction);

   // The handle method checks the current key down event against 
   // list of registered key/key status entries. If a match is found 
   // and it's a new event (key was not already down) corresponding 
   // function is invoked.
   virtual bool handle(const osgGA::GUIEventAdapter& ea,
                                         osgGA::GUIActionAdapter&);

   // Overloaded accept method for dealing with event handler visitors
   virtual void accept(osgGA::GUIEventHandlerVisitor& v)
                                               { v.visit(*this); };

protected:

   // Storage for registered 'key down' methods and key status
   keyFunctionMap keyFuncMap;

   // Storage for registered 'key up' methods and key status
   keyFunctionMap keyUPFuncMap;
};
#endif

---