Events/ActionContext.hpp

Go to the documentation of this file.

//
// Thor C++ Library
// Copyright (c) 2011-2012 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_ACTIONCONTEXT_HPP
#define THOR_ACTIONCONTEXT_HPP


namespace sf
{

    class Window;
    class Event;

} // namespace sf


namespace thor
{


template <typename ActionIdentifier>
struct ActionContext
{
    // Constructor
    ActionContext(sf::Window& window, const sf::Event* event, const ActionIdentifier& actionId)
    : Window(&window)
    , Event(event)
    , ActionId(actionId)
    {
    }

    sf::Window*                 Window;

    const sf::Event*            Event;

    ActionIdentifier            ActionId;
};



// Extracts the ID of an ActionContext object (needed by EventSystem)
template <typename ActionIdentifier>
ActionIdentifier ExtractEventIdentifier(const ActionContext<ActionIdentifier>& event)
{
    return event.ActionId;
}

} // namespace thor

#endif // THOR_ACTIONCONTEXT_HPP