source: code/branches/input/src/core/InputManager.h @ 1195

/*
 *   ORXONOX - the hottest 3D action shooter ever to exist
 *                    > www.orxonox.net <
 *
 *
 *   License notice:
 *
 *   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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 *   Author:
 *      Reto Grieder
 *   Co-authors:
 *      ...
 *
 */

/**
 @file
 @brief Implementation of a little Input handler that distributes everything
        coming from OIS.
 */

#ifndef _InputManager_H__
#define _InputManager_H__

#include "CorePrereqs.h"

#include <map>
#include <list>

#include "ois/OIS.h"
#include "Tickable.h"
#include "InputEvent.h"

namespace orxonox
{
  /**
    @brief Captures and distributes mouse and keyboard input.
    It resolves the key bindings to InputEvents which can be heard by
    implementing the InputEventListener interface.
  */
  class _CoreExport InputManager
        : public Tickable,
          public OIS::MouseListener, public OIS::KeyListener, public OIS::JoyStickListener
  {
  public: // enumerations
    /**
      @brief Designates the way input is handled and redirected.
    */
    enum InputState
    {
      IS_UNINIT,  //!< InputManager has not yet been initialised.
      IS_NONE,    //!< Input is discarded.
      IS_NORMAL,  //!< Normal play state. Key and button bindings are active.
      IS_GUI,     //!< All OIS input events are passed to CEGUI.
      IS_CONSOLE, //!< Keyboard input is redirected to the InputBuffer.
      IS_CUSTOM   //!< Any possible configuration.
    };

  public: // functions
    // METHODS OF THE STATIC INTERFACE

    static bool initialise(size_t windowHnd, int windowWidth, int windowHeight,
          bool createKeyboard = true, bool createMouse = true, bool createJoySticks = false);
    static void destroy();

    static void setWindowExtents(int width, int height);

    static void setInputState(const InputState state);
    static InputState getInputState();
    static void setKeyBindingState           (bool bActive);
    static void setMouseButtonBindingState   (bool bActive);
    static void setJoyStickButtonBindingState(bool bActive);

    static bool addKeyListener(OIS::KeyListener* listener, const std::string& name);
    static bool removeKeyListener  (const std::string& name);
    static bool enableKeyListener  (const std::string& name);
    static bool disableKeyListener (const std::string& name);
    static bool isKeyListenerActive(const std::string& name);
    static OIS::KeyListener* getKeyListener(const std::string& name);

    static bool addMouseListener(OIS::MouseListener* listener, const std::string& name);
    static bool removeMouseListener  (const std::string& name);
    static bool enableMouseListener  (const std::string& name);
    static bool disableMouseListener (const std::string& name);
    static bool isMouseListenerActive(const std::string& name);
    static OIS::MouseListener* getMouseListener(const std::string& name);

    static bool addJoyStickListener(OIS::JoyStickListener* listener, const std::string& name);
    static bool removeJoyStickListener  (const std::string& name);
    static bool enableJoyStickListener  (const std::string& name);
    static bool disableJoyStickListener (const std::string& name);
    static bool isJoyStickListenerActive(const std::string& name);
    static OIS::JoyStickListener* getJoyStickListener(const std::string& name);

    // Temporary solutions. Will be removed soon!
    static OIS::Mouse*    getMouse()    { return _getSingleton().mouse_   ; }
    static OIS::Keyboard* getKeyboard() { return _getSingleton().keyboard_; }

  private: // functions
    // don't mess with a Singleton
    InputManager ();
    InputManager (const InputManager&);
    ~InputManager();

    // Intenal methods
    bool _initialise(size_t, int, int, bool, bool, bool);
    void _initialiseKeyboard();
    void _initialiseMouse();
    void _initialiseJoySticks();
    void _destroy();
    //void _setDefaultState();
    bool _loadBindings();
    void _clearBindings();
    void _setNumberOfJoysticks(int size);

    void tick(float dt);

    // input events
                bool mousePressed  (const OIS::MouseEvent    &arg, OIS::MouseButtonID id);
                bool mouseReleased (const OIS::MouseEvent    &arg, OIS::MouseButtonID id);
    bool mouseMoved    (const OIS::MouseEvent    &arg);
                bool keyPressed    (const OIS::KeyEvent      &arg);
                bool keyReleased   (const OIS::KeyEvent      &arg);
                bool buttonPressed (const OIS::JoyStickEvent &arg, int button);
                bool buttonReleased(const OIS::JoyStickEvent &arg, int button);
                bool axisMoved     (const OIS::JoyStickEvent &arg, int axis);
                bool sliderMoved   (const OIS::JoyStickEvent &arg, int id);
                bool povMoved      (const OIS::JoyStickEvent &arg, int id);

    static InputManager& _getSingleton();
    static InputManager* _getSingletonPtr() { return &_getSingleton(); }

  private: // variables
    OIS::InputManager* inputSystem_;    //!< OIS input manager
    OIS::Keyboard*     keyboard_;       //!< OIS mouse
    OIS::Mouse*        mouse_;          //!< OIS keyboard
    std::vector<OIS::JoyStick*> joySticks_;       //!< OIS joy sticks

    InputState state_;
    InputState stateRequest_;

    bool bKeyBindingsActive_;
    bool bMouseButtonBindingsActive_;
    std::vector<bool> bJoyStickButtonBindingsActive_;

    std::map<std::string, OIS::KeyListener*>      listenersKey_;
    std::map<std::string, OIS::MouseListener*>    listenersMouse_;
    std::map<std::string, OIS::JoyStickListener*> listenersJoySticks_;

    std::list<OIS::KeyListener*>      listenersKeyActive_;
    std::list<OIS::MouseListener*>    listenersMouseActive_;
    std::list<OIS::JoyStickListener*> listenersJoySticksActive_;

    std::list<OIS::KeyCode>         keysDown_;
    std::list<OIS::MouseButtonID>   mouseButtonsDown_;
    std::vector< std::list<int> >   joyStickButtonsDown_;


    /** denotes the maximum number of different keys there are in OIS.
        256 should be ok since the highest number in the OIS enum is 237. */
    static const int numberOfKeys_s = 256;
    //! Array of input events for every pressed key
    std::string bindingsKeyPress_  [numberOfKeys_s];
    //! Array of input events for every released key
    std::string bindingsKeyRelease_[numberOfKeys_s];
    //! Array of input events for every held key
    std::string bindingsKeyHold_   [numberOfKeys_s];

    /** denotes the maximum number of different buttons there are in OIS.
        16 should be ok since the highest number in the OIS enum is 7. */
    static const int numberOfMouseButtons_s = 16;
    //! Array of input events for every pressed mouse button
    std::string bindingsMouseButtonPress_  [numberOfMouseButtons_s];
    //! Array of input events for every released mouse button
    std::string bindingsMouseButtonRelease_[numberOfMouseButtons_s];
    //! Array of input events for every held mouse button
    std::string bindingsMouseButtonHold_   [numberOfMouseButtons_s];

    /** denotes the maximum number of different buttons there are in OIS.
        32 should be ok. */
    static const int numberOfJoyStickButtons_s = 32;
    std::vector< std::vector< std::string > > bindingsJoyStickButtonPress_;
    std::vector< std::vector< std::string > > bindingsJoyStickButtonRelease_;
    std::vector< std::vector< std::string > > bindingsJoyStickButtonHold_;

  };
}

#endif /* _InputManager_H__ */