ControlsManager.h

/*
 * This file is part of Bubba-3D.
 *
 * Bubba-3D is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * Bubba-3D 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with Bubba-3D. If not, see http://www.gnu.org/licenses/.
 */
// Created by simon on 2015-12-20.
//

#ifndef BUBBA_3D_CONTROLSMANAGER_H
#define BUBBA_3D_CONTROLSMANAGER_H

#include <Input.h>
#include <vector>

typedef std::map<int,std::vector<Input*>> functionCollection ;

/*
 * \brief Used to handle player controls.
 *
 * This class is used to handle the controls of the game. A short explanation
 * of how to use the class is used is given here. You can get the singleton by calling
 * getInstance().
 *
 * The bindings can be a dual binding. This means that a function has a negative
 * and positive meaning. This is a very common concept for example turning right/left
 * or accelerating forwards/backwards. A joystick axis is naturally dual but to make
 * keyboard buttons dual you have to specify two buttons. An example of a turning function
 * (controlled with A/D or the left joystick thumb stick x-axis) and an acceleration function (controlled
 * by W/S or the left joystick thumb stick y-axis) is given below. We also add a jumping button as an example
 * of a non-dual button.
 *
 * \code{.cpp}
 * //Global enum defined elsewhere:
 * enum Controls : int {TURN,ACCELERATE,JUMP};
 *
 * ControlsManager cm = ControlsManager::getInstance();
 * cm->addBindings(ACCELERATE,{new KeyboardButton(sf::Keyboard::S,sf::Keyboard::W),new JoystickAxis(IJoystickTranslation::LEFT_THUMBSTICK_Y,true)});
 * cm->addBindings(TURN,{new KeyboardButton(sf::Keyboard::D,sf::Keyboard::A),new JoystickAxis(IJoystickTranslation::LEFT_THUMBSTICK_X,true)});
 * cm->addBindings(JUMP,{new KeyboardButton(sf::Keyboard::Space),new JoystickButton(IJoystickTranslation::A)});
 * \endcode
 *
 * The boolean true in the second argument to the joystick axis says that the joystick is truly dual.
 * If the keyboard buttons and the joystick steers in different directions just switch there order in the parameters
 * ((sf::Keyboard::D,sf::Keyboard::A) -> (sf::Keyboard::A,sf::Keyboard::D)).
 *
 * \warning A function can only have one assignment from one device. The turn function can't have both A/D
 *          and arrow left/arrow right as both are on the keyboard. The latest specified overrides the old.
 */
class ControlsManager {
public:

    void addBinding(int function, Input* button);

    void addBindings(int function, std::initializer_list<Input*> buttons);

    void clearBindings();

    ControlStatus getStatus(int function);

    static ControlsManager* getInstance();

private:
    ControlsManager();
    ~ControlsManager();
    functionCollection functions;
    void addBindingsForNewFunction(int function, std::initializer_list<Input*> buttons);
    void addBindingsForExistingFunction(int function, std::initializer_list<Input*> buttons,
                                        std::vector<Input*> bindings);
    void removeBindingsWithActivator(std::vector<Input*> *bindings,ControlStatus::Activator toRemove);
};


#endif //BUBBA_3D_CONTROLSMANAGER_H