Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/input/src/core/input/InputState.h @ 1637

Last change on this file since 1637 was 1637, checked in by rgrieder, 16 years ago

Finally! The InputManager is now working like I imagined it to. And it's even easier to use it as well.
A little explanation: Every time you change something about the input distribution, it is a change of 'state' represented by the class 'InputState'.
That can be for instance: "console", "game", "gui", etc. Every state has a name and a priority which describes who comes first. Now if one state doesn't handle mouse input or instance, then the one with the next lower priority gets it. To prevent that, you can add the 'EmptyHandler' to the state with setMouseHandler.
InputState is just an abstract base class. There are two classes implementing it: SimpleInputState and ExtendedInputState. The latter allows for multiple input handlers for one single device.

Basically, what you need to know is what you see in Orxonox.cc, InGameConsole.cc and Shell.cc.
  • Property svn:eol-style set to native
File size: 4.2 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/**
30@file
31@brief
32*/
33
34#ifndef _InputState_H__
35#define _InputState_H__
36
37#include "core/CorePrereqs.h"
38
39#include <string>
40#include <vector>
41#include "core/Executor.h"
42#include "InputInterfaces.h"
43
44namespace orxonox
45{
46    class _CoreExport InputState
47    {
48        friend class InputManager;
49
50    public:
51        InputState() : priority_(0), executorOnEnter_(0), executorOnLeave_(0) { }
52        virtual ~InputState() { }
53
54        const std::string& getName() const { return name_; }
55        int getPriority()            const { return priority_; }
56
57        bool isInputDeviceEnabled(unsigned int device)
58        {
59            if (device < bInputDeviceEnabled_.size())
60                return bInputDeviceEnabled_[device];
61            else
62                return false;
63        }
64
65        virtual void onEnter() { if (executorOnEnter_) (*executorOnEnter_)(); }
66        virtual void onLeave() { if (executorOnLeave_) (*executorOnLeave_)(); }
67
68        virtual void registerOnEnter(Executor* executor)      { executorOnEnter_ = executor; }
69        virtual void unRegisterOnEnter()                      { executorOnEnter_ = 0; }
70        virtual void registerOnLeave(Executor* executor)      { executorOnLeave_ = executor; }
71        virtual void unRegisterOnLeave()                      { executorOnLeave_ = 0; }
72
73        virtual void tickInput(float dt, unsigned int device) = 0;
74        virtual void tickInput(float dt) = 0;
75
76        virtual void keyPressed (const KeyEvent& evt) = 0;
77        virtual void keyReleased(const KeyEvent& evt) = 0;
78        virtual void keyHeld    (const KeyEvent& evt) = 0;
79
80        virtual void mouseButtonPressed (MouseButton::Enum id) = 0;
81        virtual void mouseButtonReleased(MouseButton::Enum id) = 0;
82        virtual void mouseButtonHeld    (MouseButton::Enum id) = 0;
83        virtual void mouseMoved         (IntVector2 abs, IntVector2 rel, IntVector2 clippingSize) = 0;
84        virtual void mouseScrolled      (int abs, int rel) = 0;
85
86        virtual void joyStickButtonPressed (unsigned int joyStickID, unsigned int button) = 0;
87        virtual void joyStickButtonReleased(unsigned int joyStickID, unsigned int button) = 0;
88        virtual void joyStickButtonHeld    (unsigned int joyStickID, unsigned int button) = 0;
89        virtual void joyStickAxisMoved     (unsigned int joyStickID, unsigned int axis, float value) = 0;
90
91    protected:
92        virtual void numberOfJoySticksChanged(unsigned int n) = 0;
93        void setInputDeviceEnabled(unsigned int device, bool bEnabled)
94        {
95            if (device < bInputDeviceEnabled_.size())
96                bInputDeviceEnabled_[device] = bEnabled;
97        }
98
99    private:
100        void setNumOfJoySticks(unsigned int n)
101        {
102            bInputDeviceEnabled_.resize(n + 2);
103            numberOfJoySticksChanged(n);
104        }
105        void setName(const std::string& name)  { name_ = name; }
106        void setPriority(int priority)         { priority_ = priority; }
107
108        std::string                                 name_;
109        int                                         priority_;
110        std::vector<bool>                           bInputDeviceEnabled_;
111
112        Executor*                                   executorOnEnter_;
113        Executor*                                   executorOnLeave_;
114    };
115}
116
117#endif /* _InputState_H__ */
Note: See TracBrowser for help on using the repository browser.