InputManager.h

Go to the documentation of this file.

/*
 *   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:
 *      ...
 *
 */

#ifndef _InputManager_H__
#define _InputManager_H__

#include "InputPrereqs.h"

#include <map>
#include <string>
#include <vector>
#include <functional>

#include "util/Singleton.h"
#include "util/tribool.h"
#include "core/WindowEventListener.h"

// tolua_begin
namespace orxonox
{
    class _CoreExport InputManager
// tolua_end
        : public Singleton<InputManager>, public WindowEventListener
    { // tolua_export
        friend class Singleton<InputManager>;
    public:
        enum State
        {
            Nothing       = 0x00,
            Bad           = 0x02,
            Calibrating   = 0x04,
        };

        InputManager();
        ~InputManager();
        void setConfigValues();

        void preUpdate(const Clock& time);
        void clearBuffers();
        void calibrate();
        void reload();

        //-------------------------------
        // Input States
        //-------------------------------
        InputState* createInputState(const std::string& name, bool bAlwaysGetsInput = false, bool bTransparent = false, InputStatePriority priority = InputStatePriority::Dynamic);
        InputState* getState(const std::string& name);
        bool enterState(const std::string& name); // tolua_export
        bool leaveState(const std::string& name); // tolua_export
        bool destroyState(const std::string& name); // tolua_export
        bool setMouseExclusive(const std::string& name, tribool value); // tolua_export

        //-------------------------------
        // Various getters and setters
        //-------------------------------
        unsigned int getJoyStickQuantity() const
            { return devices_.size() - InputDeviceEnumerator::FirstJoyStick; }
        OIS::InputManager* getOISInputManager() { return this->oisInputManager_; }
        std::pair<int, int> getMousePosition() const;
        bool isMouseExclusive() const { return this->exclusiveMouse_; } // tolua_export

        //-------------------------------
        // Function call caching
        //-------------------------------
        void pushCall(const std::function<void ()>& function)
            { this->callBuffer_.push_back(function); }

        static InputManager& getInstance() { return Singleton<InputManager>::getInstance(); } // tolua_export

    private: // functions
        // non-copyable:
        InputManager(const InputManager&) = delete;
        InputManager& operator=(const InputManager&) = delete;

        // Internal methods
        void loadDevices();
        void loadMouse();
        void loadJoySticks();
        void destroyDevices();

        void stopCalibration();
        void reloadInternal();

        void destroyStateInternal(InputState* state);
        void updateActiveStates();

        // From WindowEventListener
        virtual void windowFocusChanged(bool bFocus) override;

    private: // variables
        State                               internalState_;        
        OIS::InputManager*                  oisInputManager_;      
        std::vector<InputDevice*>           devices_;              
        bool                                exclusiveMouse_;       

        // some internally handled states and handlers
        InputState*                         emptyState_;           
        InputBuffer*                        calibratorCallbackHandler_;

        std::map<std::string, InputState*>  statesByName_;         
        std::map<int, InputState*>          activeStates_;         
        std::vector<InputState*>            activeStatesTicked_;   

        std::vector<std::function<void ()>> callBuffer_;        

        static InputManager*                singletonPtr_s;        
    }; // tolua_export
} // tolua_export

#endif /* _InputManager_H__ */