Action.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2016 Jan Haller
//
// 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.
//


#ifndef THOR_ACTION_HPP
#define THOR_ACTION_HPP

#include <Thor/Input/Detail/ActionOperations.hpp>
#include <Thor/Config.hpp>

#include <functional>


namespace thor
{
namespace detail
{

    class EventBuffer;

} // namespace detail

// ---------------------------------------------------------------------------------------------------------------------------



class THOR_API Action
{
    // ---------------------------------------------------------------------------------------------------------------------------
    // Public types
    public:

        enum ActionType
        {
            Hold,           
            PressOnce,      
            ReleaseOnce,    
        };


    // ---------------------------------------------------------------------------------------------------------------------------
    // Public member functions
    public:
        explicit                    Action(sf::Keyboard::Key key, ActionType action = Hold);

        explicit                    Action(sf::Mouse::Button mouseButton, ActionType action = Hold);

        explicit                    Action(JoystickButton joystickState, ActionType action = Hold);

        explicit                    Action(JoystickAxis joystickAxis);

        explicit                    Action(sf::Event::EventType eventType);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Implementation details
    public:
        // Default constructor: Required for ActionMap::operator[] - constructs an uninitialized action
                                    Action();

        // Tests if the event/real time input constellation in the argument is true for this action
        bool                        isActive(const detail::EventBuffer& buffer) const;

        // Test if active and store relevant events
        bool                        isActive(const detail::EventBuffer& buffer, detail::ActionResult& out) const;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private member functions
    private:
        // Construct from movable pointer to the action's operation
        explicit                    Action(detail::ActionNode::CopiedPtr operation);


    // ---------------------------------------------------------------------------------------------------------------------------
    // Private variables
    private:
        detail::ActionNode::CopiedPtr   mOperation;


    // ---------------------------------------------------------------------------------------------------------------------------
    // Friends
    friend Action THOR_API operator|| (const Action& lhs, const Action& rhs);
    friend Action THOR_API operator&& (const Action& lhs, const Action& rhs);
    friend Action THOR_API operator! (const Action& action);
    friend Action THOR_API eventAction(std::function<bool(const sf::Event&)> filter);
    friend Action THOR_API realtimeAction(std::function<bool()> filter);
};


Action THOR_API             operator|| (const Action& lhs, const Action& rhs);

Action THOR_API             operator&& (const Action& lhs, const Action& rhs);

Action THOR_API             operator! (const Action& action);

Action THOR_API             eventAction(std::function<bool(const sf::Event&)> filter);

Action THOR_API             realtimeAction(std::function<bool()> filter);



} // namespace thor

#endif // THOR_ACTION_HPP