Changeset 5863

Timestamp:

Oct 3, 2009, 5:33:31 PM (15 years ago)

Author:

rgrieder

Message:

New class: KeyBinderManager (yes, it really was necessary, I'm not such a Fan of zillions of classes as well) and moved the keybind command to it from GSLevel.
This new Singleton simply maps the keybind command to the right KeyBinder, selected by KeyBinderManager::setCurrent().
There is also a default KeyBinder (with keybindings.ini as file), which should do the Trick for now. Other Keybinders should only server special purposes (like in mini games or so).

DELETE YOUR keybindings.ini FILE! =

Location:

code/branches/core5

Files:

• data/defaultConfig/keybindings.ini (modified) (3 diffs)
• data/defaultConfig/masterKeybindings.ini (deleted)
• src/libraries/core/Core.cc (modified) (3 diffs)
• src/libraries/core/Core.h (modified) (1 diff)
• src/libraries/core/CorePrereqs.h (modified) (1 diff)
• src/libraries/core/input/CMakeLists.txt (modified) (1 diff)
• src/libraries/core/input/InputManager.cc (modified) (1 diff)
• src/libraries/core/input/InputManager.h (modified) (1 diff)
• src/libraries/core/input/KeyBinder.cc (modified) (4 diffs)
• src/libraries/core/input/KeyBinder.h (modified) (5 diffs)
• src/libraries/core/input/KeyBinderManager.cc (added)
• src/libraries/core/input/KeyBinderManager.h (added)
• src/orxonox/gamestates/GSGraphics.cc (modified) (3 diffs)
• src/orxonox/gamestates/GSGraphics.h (modified) (1 diff)
• src/orxonox/gamestates/GSLevel.cc (modified) (9 diffs)
• src/orxonox/gamestates/GSLevel.h (modified) (1 diff)
• src/orxonox/gamestates/GSMainMenu.cc (modified) (3 diffs)

code/branches/core5/data/defaultConfig/keybindings.ini

@@ -25 +25 @@
 KeyEscape="exit"
 KeyF="scale -1 moveUpDown"
-KeyF1=
+KeyF1="OverlayGroup toggleVisibility Debug"
 KeyF10=
 KeyF11=
@@ -41 +41 @@
 KeyF9=
 KeyG=greet
-KeyGrave=
+KeyGrave="openConsole"
 KeyH=
 KeyHome=showGUI
@@ -126 +126 @@
 KeyU=
 KeyUP="scale 1 moveFrontBack"
-KeyUnassigned=
+KeyUnassigned="openConsole"
 KeyUnderline=
 KeyUnlabeled=

code/branches/core5/src/libraries/core/Core.cc

@@ -69 +69 @@
 #include "TclThreadManager.h"
 #include "input/InputManager.h"
+#include "input/KeyBinderManager.h"
 
 namespace orxonox
@@ -288 +289 @@
         inputManager_.reset(new InputManager());
 
+        // Manages KeyBinders and makes them available
+        keyBinderManager_.reset(new KeyBinderManager());
+
         // load the CEGUI interface
         guiManager_.reset(new GUIManager(graphicsManager_->getRenderWindow(),
@@ -304 +308 @@
         this->graphicsScope_.reset();
         this->guiManager_.reset();
+        this->keyBinderManager_.reset();
         this->inputManager_.reset();
         this->graphicsManager_.reset();

code/branches/core5/src/libraries/core/Core.h

@@ -100 +100 @@
             scoped_ptr<GraphicsManager>   graphicsManager_;     //!< Interface to OGRE
             scoped_ptr<InputManager>      inputManager_;        //!< Interface to OIS
+            scoped_ptr<KeyBinderManager>  keyBinderManager_;    //!< Manages all KeyBinders
             scoped_ptr<GUIManager>        guiManager_;          //!< Interface to GUI
             scoped_ptr<Scope<ScopeID::Root> >     rootScope_;

code/branches/core5/src/libraries/core/CorePrereqs.h

@@ -212 +212 @@
     class JoyStick;
     class KeyBinder;
+    class KeyBinderManager;
     class Keyboard;
     class KeyDetector;

code/branches/core5/src/libraries/core/input/CMakeLists.txt

@@ -9 +9 @@
   JoyStickQuantityListener.cc
   KeyBinder.cc
+  KeyBinderManager.cc
   Keyboard.cc
   KeyDetector.cc

code/branches/core5/src/libraries/core/input/InputManager.cc

@@ -264 +264 @@
     }
 
-    void InputManager::setKeyDetectorCallback(const std::string& command)
-    {
-        this->keyDetector_->setCallbackCommand(command);
-    }
-
     // ############################################################
     // #####                    Destruction                   #####

code/branches/core5/src/libraries/core/input/InputManager.h

@@ -161 +161 @@
         // Various getters and setters
         //-------------------------------
-        //! Sets the the name of the command used by the KeyDetector as callback.
-        void setKeyDetectorCallback(const std::string& command);
         //! Returns the number of joy stick that have been created since the c'tor or last call to reload().
         unsigned int getJoyStickQuantity() const

code/branches/core5/src/libraries/core/input/KeyBinder.cc

@@ -27 +27 @@
  */
 
-/**
- @file
- @brief Implementation of the different input handlers.
- */
-
 #include "KeyBinder.h"
 
 #include "util/Convert.h"
 #include "util/Debug.h"
+#include "util/Exception.h"
 #include "core/ConfigValueIncludes.h"
 #include "core/CoreIncludes.h"
@@ -48 +44 @@
         Constructor that does as little as necessary.
     */
-    KeyBinder::KeyBinder()
+    KeyBinder::KeyBinder(const std::string& filename)
         : deriveTime_(0.0f)
+        , filename_(filename)
     {
         mouseRelative_[0] = 0;
@@ -103 +100 @@
         // set them here to use allHalfAxes_
         setConfigValues();
+
+        // Load the bindings if filename was given
+        if (!this->filename_.empty())
+            this->loadBindings();
     }
 
@@ -240 +241 @@
     @brief
         Loads the key and button bindings.
-    @return
-        True if loading succeeded.
-    */
-    void KeyBinder::loadBindings(const std::string& filename)
+    */
+    void KeyBinder::loadBindings()
     {
         COUT(3) << "KeyBinder: Loading key bindings..." << std::endl;
 
-        if (filename.empty())
-            return;
-
-        if (this->configFile_ == ConfigFileType::NoType)
-        {
-            // Get a new ConfigFileType from the ConfigFileManager
-            this->configFile_ = ConfigFileManager::getInstance().getNewConfigFileType();
-        }
-
-        ConfigFileManager::getInstance().setFilename(this->configFile_, filename);
+        // Get a new ConfigFileType from the ConfigFileManager
+        this->configFile_ = ConfigFileManager::getInstance().getNewConfigFileType();
+
+        ConfigFileManager::getInstance().setFilename(this->configFile_, this->filename_);
 
         // Parse bindings and create the ConfigValueContainers if necessary
-        clearBindings();
         for (std::map<std::string, Button*>::const_iterator it = allButtons_.begin(); it != allButtons_.end(); ++it)
             it->second->readConfigValue(this->configFile_);

code/branches/core5/src/libraries/core/input/KeyBinder.h

@@ -26 +26 @@
  *
  */
-
-/**
-@file
-@brief
-    Different definitions of input processing.
-*/
 
 #ifndef _KeyBinder_H__
@@ -53 +47 @@
     /**
     @brief
-        Handles mouse, keyboard and joy stick input while in the actual game mode.
-        Manages the key bindings.
+        Maps mouse, keyboard and joy stick input to command strings and executes them.
+
+        The bindings are stored in ini-files (like the one for configValues) in the config Path.
+    @remarks
+        You cannot change the filename because the KeyBinderManager maps these filenames to the
+        KeyBinders. If you need to load other bindings, just create a new one.
     */
     class _CoreExport KeyBinder : public InputHandler, public JoyStickQuantityListener
     {
     public:
-        KeyBinder ();
+        KeyBinder (const std::string& filename);
         virtual ~KeyBinder();
 
-        void loadBindings(const std::string& filename);
         void clearBindings();
         bool setBinding(const std::string& binding, const std::string& name, bool bTemporary = false);
+        const std::string& getBindingsFilename()
+            { return this->filename_; }
         void setConfigValues();
         void resetJoyStickAxes();
 
     protected: // functions
+        void loadBindings();
+        void buttonThresholdChanged();
+        void initialiseJoyStickBindings();
+        void compilePointerLists();
+        // from JoyStickQuantityListener interface
+        virtual void JoyStickQuantityChanged(const std::vector<JoyStick*>& joyStickList);
+
         void allDevicesUpdated(float dt);
         void mouseUpdated(float dt);
@@ -74 +80 @@
         // internal
         void tickHalfAxis(HalfAxis& halfAxis);
-
-        void buttonThresholdChanged();
-        // from JoyStickQuantityListener interface
-        virtual void JoyStickQuantityChanged(const std::vector<JoyStick*>& joyStickList);
-        void initialiseJoyStickBindings();
-        void compilePointerLists();
 
         void buttonPressed (const KeyEvent& evt);
@@ -144 +144 @@
         float deriveTime_;
 
+        //! Name of the file used in this KeyBinder (constant!)
+        const std::string filename_;
         //! Config file used. ConfigFileType::NoType in case of KeyDetector. Also indicates whether we've already loaded.
         ConfigFileType configFile_;
@@ -171 +173 @@
     };
 
+
     inline void KeyBinder::buttonPressed (const KeyEvent& evt)
     { assert(!keys_[evt.getKeyCode()].name_.empty()); keys_[evt.getKeyCode()].execute(KeybindMode::OnPress); }

code/branches/core5/src/orxonox/gamestates/GSGraphics.cc

@@ -41 +41 @@
 #include "core/Game.h"
 #include "core/GUIManager.h"
-#include "core/input/InputManager.h"
-#include "core/input/KeyBinder.h"
-#include "core/input/InputState.h"
 #include "core/Loader.h"
 #include "core/XMLFile.h"
@@ -56 +53 @@
     GSGraphics::GSGraphics(const GameStateInfo& info)
         : GameState(info)
-        , masterKeyBinder_(0)
-        , masterInputState_(0)
         , debugOverlay_(0)
     {
-        // load master key bindings
-        masterInputState_ = InputManager::getInstance().createInputState("master", true);
-        masterKeyBinder_ = new KeyBinder();
-        masterInputState_->setKeyHandler(masterKeyBinder_);
     }
 
     GSGraphics::~GSGraphics()
     {
-        InputManager::getInstance().destroyState("master");
-        this->masterKeyBinder_->destroy();
     }
 
@@ -94 +83 @@
         Loader::open(debugOverlay_);
 
-        masterKeyBinder_->loadBindings("masterKeybindings.ini");
-
         // add console command to toggle GUI
         this->ccToggleGUI_ = createConsoleCommand(createFunctor(&GSGraphics::toggleGUI, this), "toggleGUI");
         CommandExecutor::addConsoleCommandShortcut(this->ccToggleGUI_);
-
-        // enable master input
-        InputManager::getInstance().enterState("master");
     }
 

code/branches/core5/src/orxonox/gamestates/GSGraphics.h

@@ -60 +60 @@
 
     private:
-        KeyBinder*            masterKeyBinder_;     //!< Key binder for master key bindings
-        InputState*           masterInputState_;    //!< Special input state for master input
         XMLFile*              debugOverlay_;
         ConsoleCommand*       ccToggleGUI_;         //!< Console command to toggle GUI

code/branches/core5/src/orxonox/gamestates/GSLevel.cc

@@ -35 +35 @@
 #include "core/input/InputManager.h"
 #include "core/input/InputState.h"
-#include "core/input/KeyBinder.h"
+#include "core/input/KeyBinderManager.h"
 #include "core/ConsoleCommand.h"
 #include "core/ConfigValueIncludes.h"
@@ -57 +57 @@
     GSLevel::GSLevel(const GameStateInfo& info)
         : GameState(info)
-        , keyBinder_(0)
         , gameInputState_(0)
         , guiMouseOnlyInputState_(0)
@@ -63 +62 @@
     {
         RegisterObject(GSLevel);
-
-        this->ccKeybind_ = 0;
-        this->ccTkeybind_ = 0;
     }
 
@@ -74 +70 @@
     void GSLevel::setConfigValues()
     {
-        SetConfigValue(keyDetectorCallbackCode_, "KeybindBindingStringKeyName=");
     }
 
@@ -84 +79 @@
         {
             gameInputState_ = InputManager::getInstance().createInputState("game");
-            keyBinder_ = new KeyBinder();
-            keyBinder_->loadBindings("keybindings.ini");
-            gameInputState_->setHandler(keyBinder_);
+            gameInputState_->setHandler(KeyBinderManager::getInstance().getDefaultAsHandler());
+            KeyBinderManager::getInstance().setToDefault();
 
             guiMouseOnlyInputState_ = InputManager::getInstance().createInputState("guiMouseOnly");
@@ -102 +96 @@
         if (GameMode::showsGraphics())
         {
-            // keybind console command
-            ccKeybind_ = createConsoleCommand(createFunctor(&GSLevel::keybind, this), "keybind");
-            CommandExecutor::addConsoleCommandShortcut(ccKeybind_);
-            ccTkeybind_ = createConsoleCommand(createFunctor(&GSLevel::tkeybind, this), "tkeybind");
-            CommandExecutor::addConsoleCommandShortcut(ccTkeybind_);
-            // set our console command as callback for the key detector
-            InputManager::getInstance().setKeyDetectorCallback(std::string("keybind ") + keyDetectorCallbackCode_);
-
             // level is loaded: we can start capturing the input
             InputManager::getInstance().enterState("game");
@@ -136 +122 @@
     void GSLevel::deactivate()
     {
-/*
-        // destroy console commands
-        if (this->ccKeybind_)
-        {
-            delete this->ccKeybind_;
-            this->ccKeybind_ = 0;
-        }
-        if (this->ccTkeybind_)
-        {
-            delete this->ccTkeybind_;
-            this->ccTkeybind_ = 0;
-        }
-*/
-
         if (GameMode::showsGraphics())
         {
@@ -181 +153 @@
             InputManager::getInstance().destroyState("guiKeysOnly");
             InputManager::getInstance().destroyState("guiMouseOnly");
-            if (this->keyBinder_)
-            {
-                this->keyBinder_->destroy();
-                this->keyBinder_ = 0;
-            }
         }
     }
@@ -211 +178 @@
         delete startFile_s;
     }
-
-    void GSLevel::keybind(const std::string &command)
-    {
-        this->keybindInternal(command, false);
-    }
-
-    void GSLevel::tkeybind(const std::string &command)
-    {
-        this->keybindInternal(command, true);
-    }
-
-    /**
-    @brief
-        Assigns a command string to a key/button/axis. The name is determined via KeyDetector.
-    @param command
-        Command string that can be executed by the CommandExecutor
-        OR: Internal string "KeybindBindingStringKeyName=" used for the second call to identify
-        the key/button/axis that has been activated. This is configured above in activate().
-    */
-    void GSLevel::keybindInternal(const std::string& command, bool bTemporary)
-    {
-        if (GameMode::showsGraphics())
-        {
-            static std::string bindingString = "";
-            static bool bTemporarySaved = false;
-            static bool bound = true;
-            // note: We use a long name to make 'sure' that the user doesn't use it accidentally.
-            // Howerver there will be no real issue if it happens anyway.
-            if (command.find(keyDetectorCallbackCode_) != 0)
-            {
-                if (bound)
-                {
-                    COUT(0) << "Press any button/key or move a mouse/joystick axis" << std::endl;
-                    InputManager::getInstance().enterState("detector");
-                    bindingString = command;
-                    bTemporarySaved = bTemporary;
-                    bound = false;
-                }
-                //else:  We're still in a keybind command. ignore this call.
-            }
-            else
-            {
-                if (!bound)
-                {
-                    // user has pressed the key
-                    std::string name = command.substr(this->keyDetectorCallbackCode_.size());
-                    COUT(0) << "Binding string \"" << bindingString << "\" on key '" << name << "'" << std::endl;
-                    this->keyBinder_->setBinding(bindingString, name, bTemporarySaved);
-                    InputManager::getInstance().leaveState("detector");
-                    bound = true;
-                }
-                // else: A key was pressed within the same tick, ignore it.
-            }
-        }
-    }
 }

code/branches/core5/src/orxonox/gamestates/GSLevel.h

@@ -57 +57 @@
         void unloadLevel();
 
-        // console commands
-        void keybind(const std::string& command);
-        void tkeybind(const std::string& command);
-        void keybindInternal(const std::string& command, bool bTemporary);
-
-        KeyBinder*               keyBinder_;               //!< tool that loads and manages the input bindings
         InputState*              gameInputState_;          //!< input state for normal ingame playing
         InputState*              guiMouseOnlyInputState_;  //!< input state if we only need the mouse to use the GUI
         InputState*              guiKeysOnlyInputState_;   //!< input state if we only need the keys to use the GUI
-
-        //##### ConfigValues #####
-        std::string           keyDetectorCallbackCode_;
-
-        // console commands
-        ConsoleCommand*       ccKeybind_;
-        ConsoleCommand*       ccTkeybind_;
     };
 }

code/branches/core5/src/orxonox/gamestates/GSMainMenu.cc

@@ -34 +34 @@
 #include "core/input/InputManager.h"
 #include "core/input/InputState.h"
+#include "core/input/KeyBinderManager.h"
 #include "core/Game.h"
 #include "core/ConsoleCommand.h"
@@ -51 +52 @@
         inputState_ = InputManager::getInstance().createInputState("mainMenu");
         inputState_->setHandler(GUIManager::getInstancePtr());
+        inputState_->setKeyHandler(KeyBinderManager::getInstance().getDefaultAsHandler());
         inputState_->setJoyStickHandler(&InputHandler::EMPTY);
         inputState_->setIsExclusiveMouse(false);
@@ -86 +88 @@
         CommandExecutor::addConsoleCommandShortcut(this->ccStartMainMenu_);
 
+        KeyBinderManager::getInstance().setToDefault();
         InputManager::getInstance().enterState("mainMenu");