input_device.h

/*
**  UICore
**  Copyright (c) 1997-2015 The UICore Team
**
**  This software is provided 'as-is', without any express or implied
**  warranty.  In no event will the authors be held liable for any damages
**  arising from the use of this software.
**
**  Permission is granted to anyone to use this software for any purpose,
**  including commercial applications, and to alter it and redistribute it
**  freely, subject to the following restrictions:
**
**  1. The origin of this software must not be misrepresented; you must not
**     claim that you wrote the original software. If you use this software
**     in a product, an acknowledgment in the product documentation would be
**     appreciated but is not required.
**  2. Altered source versions must be plainly marked as such, and must not be
**     misrepresented as being the original software.
**  3. This notice may not be removed or altered from any source distribution.
**
**  Note: Some of the libraries UICore may link to may have additional
**  requirements or restrictions.
**
**  File Author(s):
**
**    Magnus Norddahl
**    Harry Storbacka
*/

#pragma once

#include "../../Core/Signals/signal.h"
#include "../../Core/Math/point.h"
#include <memory>

namespace uicore
{
    class InputEvent;

    class InputDevice
    {
    public:
        enum Type
        {
            keyboard,
            pointer,
            joystick,
            unknown
        };

        virtual std::string name() const = 0;

        virtual std::string device_name() const = 0;

        virtual Type type() const = 0;

        //        should only be used to display the name of the key to the user
        //        and not as a key identifier inside key binding configuration
        //        files and such.
        virtual std::string key_name(int id) const = 0;

        virtual std::string keyid_to_string(int keycode) const = 0;

        virtual int string_to_keyid(const std::string &str) const = 0;

        virtual bool keycode(int keycode) const = 0;

        virtual Pointf position() const = 0;

        virtual Point device_position() const = 0;

        virtual float axis(int axisid) const = 0;

        virtual std::vector<int> axis_ids() const = 0;

        virtual int hat(int index) const = 0;

        virtual int button_count() const = 0;

        virtual void set_position(float x, float y) = 0;

        virtual void set_device_position(int x, int y) = 0;

        virtual Signal<void(const InputEvent &)> &sig_key_down() = 0;

        virtual Signal<void(const InputEvent &)> &sig_key_up() = 0;

        virtual Signal<void(const InputEvent &)> &sig_pointer_move() = 0;

        virtual Signal<void(const InputEvent &)> &sig_axis_move() = 0;

        virtual Signal<void(const InputEvent &)> &sig_key_dblclk() = 0;

        virtual Signal<void(const InputEvent &)> &sig_proximity_change() = 0;
    };

    typedef std::shared_ptr<InputDevice> InputDevicePtr;
}