Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

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

Upgrade number two for the InputManager: An InputState can have two new properties. You can tell it to always receive input, no matter what the input stack actually is. Secondly there is a 'transparent' option to be kind of invisible to the other states. I have found no use yet, but three more lines weren't a big deal ;)
This change ultimately supersedes the need for a master InputState.
  • Property svn:eol-style set to native
File size: 4.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/**
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        const std::string& getName() const { return name_; }
52        int getPriority()            const { return priority_; }
53
54        bool isInputDeviceEnabled(unsigned int device)
55        {
56            if (device < bInputDeviceEnabled_.size())
57                return bInputDeviceEnabled_[device];
58            else
59                return false;
60        }
61
62        bool handlersChanged() { return this->bHandlersChanged_; }
63        void resetHandlersChanged() { bHandlersChanged_ = false; }
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 updateInput(float dt, unsigned int device) = 0;
74        virtual void updateInput(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 (MouseButtonCode::ByEnum id) = 0;
81        virtual void mouseButtonReleased(MouseButtonCode::ByEnum id) = 0;
82        virtual void mouseButtonHeld    (MouseButtonCode::ByEnum 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, JoyStickButtonCode::ByEnum id) = 0;
87        virtual void joyStickButtonReleased(unsigned int joyStickID, JoyStickButtonCode::ByEnum id) = 0;
88        virtual void joyStickButtonHeld    (unsigned int joyStickID, JoyStickButtonCode::ByEnum id) = 0;
89        virtual void joyStickAxisMoved     (unsigned int joyStickID, unsigned int axis, float value) = 0;
90
91    protected:
92        InputState()
93            : bHandlersChanged_(false)
94            , priority_(0)
95            , bAlwaysGetsInput_(false)
96            , bTransparent_(false)
97            , executorOnEnter_(0)
98            , executorOnLeave_(0)
99        { }
100        virtual ~InputState() { }
101
102        virtual void numberOfJoySticksChanged(unsigned int n) = 0;
103        void setInputDeviceEnabled(unsigned int device, bool bEnabled)
104        {
105            if (device < bInputDeviceEnabled_.size())
106                bInputDeviceEnabled_[device] = bEnabled;
107        }
108
109        bool bHandlersChanged_;
110
111    private:
112        void setNumOfJoySticks(unsigned int n)
113        {
114            bInputDeviceEnabled_.resize(n + 2);
115            numberOfJoySticksChanged(n);
116        }
117        void setName(const std::string& name)  { name_ = name; }
118        void setPriority(int priority)         { priority_ = priority; }
119
120        std::string                                 name_;
121        int                                         priority_;
122        std::vector<bool>                           bInputDeviceEnabled_;
123        bool                                        bAlwaysGetsInput_;
124        bool                                        bTransparent_;
125
126        Executor*                                   executorOnEnter_;
127        Executor*                                   executorOnLeave_;
128    };
129}
130
131#endif /* _InputState_H__ */
Note: See TracBrowser for help on using the repository browser.