Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/ggz2/src/libraries/core/input/Keyboard.h @ 7387

Last change on this file since 7387 was 5738, checked in by landauf, 15 years ago

merged libraries2 back to trunk

  • Property svn:eol-style set to native
File size: 2.7 KB
Line 
1/*
2 *   ORXONOX - the hottest 3D action shooter ever to exist
3 *                    > www.orxonox.net <
4 *
5 *
6 *   License notice:
7 *
8 *   This program is free software; you can redistribute it and/or
9 *   modify it under the terms of the GNU General Public License
10 *   as published by the Free Software Foundation; either version 2
11 *   of the License, or (at your option) any later version.
12 *
13 *   This program is distributed in the hope that it will be useful,
14 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
15 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16 *   GNU General Public License for more details.
17 *
18 *   You should have received a copy of the GNU General Public License
19 *   along with this program; if not, write to the Free Software
20 *   Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
21 *
22 *   Author:
23 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29#ifndef _Core_Keyboard_H__
30#define _Core_Keyboard_H__
31
32#include "InputPrereqs.h"
33
34#include "InputHandler.h"
35#include "InputDevice.h"
36
37namespace orxonox
38{
39    //! Template parameter collection for the base class
40    struct KeyboardTraits
41    {
42        typedef Keyboard DeviceClass;
43        typedef OIS::Keyboard OISDeviceClass;
44        typedef KeyEvent ButtonType;
45        typedef KeyEvent& ButtonTypeParam;
46        static const OIS::Type OISDeviceValue = OIS::OISKeyboard;
47    };
48
49    /**
50    @brief
51        Wraps around an OIS::Mouse and forwards the input events to
52        a list of input states.
53
54        It also saves the state of the keyboard modifiers (like shift, etc.)
55    */
56    class _CoreExport Keyboard
57        : public InputDeviceTemplated<KeyboardTraits>
58        , public OIS::KeyListener
59    {
60        friend class InputDeviceTemplated<KeyboardTraits>;
61        //! Super class alias
62        typedef InputDeviceTemplated<KeyboardTraits> super;
63
64    public:
65        //! Only resets the keyboard modifiers. Initialising is done in the base class.
66        Keyboard(unsigned int id, OIS::InputManager* oisInputManager) : super(id, oisInputManager), modifiers_(0) { }
67        ~Keyboard() { }
68
69    private:
70        //! Resets the keyboard modifiers
71        void clearBuffersImpl() { this->modifiers_ = 0; }
72        //! Translates the KeyHandle to a KeyEvent
73        KeyEvent& getButtonEventArg(KeyEvent& button)
74        {
75            button.setModifiers(modifiers_);
76            return button;
77        }
78
79        bool keyPressed(const OIS::KeyEvent& arg);
80        bool keyReleased(const OIS::KeyEvent& arg);
81
82        //! Returns the class name as string
83        static std::string getClassNameImpl() { return "Keyboard"; }
84
85        //! Bit mask representing keyboard modifiers
86        int modifiers_;
87    };
88}
89
90#endif /* _Core_Keyboard_H__ */
Note: See TracBrowser for help on using the repository browser.