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

/*
 *   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 "core/CorePrereqs.h"

#include <map>
#include <vector>
#include <stack>
#include "util/Math.h"
#include "core/OrxonoxClass.h"
#include "InputInterfaces.h"

namespace orxonox
{
    /**
    @brief
        Helper class to realise a vector<int[4]>
    */
    class POVStates
    {
    public:
        int operator[](unsigned int index) { return povStates[index]; }
        int povStates[4];
    };

    /**
    @brief
        Helper class to realise a vector< {int[4], int[4]} >
    */
    class SliderStates
    {
    public:
        IntVector2 sliderStates[4];
    };

    struct JoyStickCalibration
    {
        int zeroStates[24];
        float positiveCoeff[24];
        float negativeCoeff[24];
    };

    /**
    @brief
        Captures and distributes mouse and keyboard input.
    */
    class _CoreExport InputManager
        : public OrxonoxClass,
        public OIS::KeyListener, public OIS::MouseListener, public OIS::JoyStickListener
    {
        // --> setConfigValues is private
        friend ClassIdentifier<InputManager>;

    public: // static functions
        static bool initialise(const size_t windowHnd, int windowWidth, int windowHeight,
                               bool createKeyboard = true, bool createMouse = true, bool createJoySticks = false);
        static bool initialiseKeyboard();
        static bool initialiseMouse();
        static bool initialiseJoySticks();
        static int  numberOfKeyboards();
        static int  numberOfMice();
        static int  numberOfJoySticks();

        static void destroy();
        static void destroyKeyboard();
        static void destroyMouse();
        static void destroyJoySticks();

        //static bool isModifierDown(KeyboardModifier::Enum modifier);
        //static bool isKeyDown(KeyCode::Enum key);
        //static const MouseState getMouseState();
        //static const JoyStickState getJoyStickState(unsigned int ID);

        static void setWindowExtents(const int width, const int height);

        static void storeKeyStroke(const std::string& name);
        static void keyBind(const std::string& command);

        static void calibrate();

        static void tick(float dt);

        static SimpleInputState*   createSimpleInputState  (const std::string& name, int priority);
        static ExtendedInputState* createExtendedInputState(const std::string& name, int priority);
        static bool destroyState (const std::string& name);
        //static bool removeState (const std::string& name);
        static InputState* getState       (const std::string& name);
        static InputState* getCurrentState();
        static bool requestEnterState     (const std::string& name);
        static bool requestLeaveState     (const std::string& name);

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

        // Intenal methods
        bool _initialise(const size_t, int, int, bool, bool, bool);
        bool _initialiseKeyboard();
        bool _initialiseMouse();
        bool _initialiseJoySticks();
        void _redimensionLists();

        void _destroy();
        void _destroyKeyboard();
        void _destroyMouse();
        void _destroyJoySticks();
        void _destroyState(InputState* state);

        void _completeCalibration();

        void _fireAxis(unsigned int iJoyStick, int axis, int value);
        unsigned int _getJoystick(const OIS::JoyStickEvent& arg);

        void _tick(float dt);

        void _updateActiveStates();
        bool _configureInputState(InputState* state, const std::string& name, int priority);

        // 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);

        void setConfigValues();

        static InputManager& _getInstance();

    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
        unsigned int                                joySticksSize_;
        unsigned int                                devicesNum_;

        // some internally handled states
        SimpleInputState*                                 stateDetector_;   //!< KeyDetector instance
        SimpleInputState*                                 stateCalibrator_;
        SimpleInputState*                                 stateEmpty_;

        std::map<std::string, InputState*>          inputStatesByName_;
        std::map<int, InputState*>                  inputStatesByPriority_;

        std::vector<InputState*> stateEnterRequests_;                  //!< Request to enter a new state
        std::vector<InputState*> stateLeaveRequests_;                    //!< Request to leave the current state

        std::map<int, InputState*> activeStates_;
        std::vector<InputState*>   activeStatesTop_;    //!< Current input states for joy stick events.
        std::vector<InputState*>   activeStatesTicked_;    //!< Current input states for joy stick events.

        // joystick calibration
        //std::vector<int> marginalsMaxConfig_;
        //std::vector<int> marginalsMinConfig_;
        int marginalsMax_[24];
        int marginalsMin_[24];
        bool bCalibrated_;
        bool bCalibrating_;

        unsigned int keyboardModifiers_;           //!< Bit mask representing keyboard modifiers
        //! Keeps track of the joy stick POV states
        std::vector<POVStates>                      povStates_;
        //! Keeps track of the possibly two slider axes
        std::vector<SliderStates>                   sliderStates_;
        std::vector<JoyStickCalibration>            joySticksCalibration_;

        std::vector<Key>                            keysDown_;
        std::vector<MouseButton::Enum>              mouseButtonsDown_;
        std::vector<std::vector<int> >              joyStickButtonsDown_;

        static std::string                          bindingCommmandString_s;
    };

}

#endif /* _InputManager_H__ */