Input/ActionContext.hpp
Go to the documentation of this file.
00001 
00002 //
00003 // Thor C++ Library
00004 // Copyright (c) 2011-2015 Jan Haller
00005 // 
00006 // This software is provided 'as-is', without any express or implied
00007 // warranty. In no event will the authors be held liable for any damages
00008 // arising from the use of this software.
00009 // 
00010 // Permission is granted to anyone to use this software for any purpose,
00011 // including commercial applications, and to alter it and redistribute it
00012 // freely, subject to the following restrictions:
00013 // 
00014 // 1. The origin of this software must not be misrepresented; you must not
00015 //    claim that you wrote the original software. If you use this software
00016 //    in a product, an acknowledgment in the product documentation would be
00017 //    appreciated but is not required.
00018 // 
00019 // 2. Altered source versions must be plainly marked as such, and must not be
00020 //    misrepresented as being the original software.
00021 // 
00022 // 3. This notice may not be removed or altered from any source distribution.
00023 //
00025 
00028 
00029 #ifndef THOR_ACTIONCONTEXT_HPP
00030 #define THOR_ACTIONCONTEXT_HPP
00031 
00032 
00033 namespace sf
00034 {
00035 
00036     class Window;
00037     class Event;
00038 
00039 } // namespace sf
00040 
00041 
00042 namespace thor
00043 {
00044 
00047 
00053 template <typename ActionId>
00054 struct ActionContext
00055 {
00056     // Constructor
00057     ActionContext(sf::Window* window, const sf::Event* event, const ActionId& actionId)
00058     : window(window)
00059     , event(event)
00060     , actionId(actionId)
00061     {
00062     }
00063 
00067     sf::Window*                 window;
00068 
00084     const sf::Event*            event;
00085 
00088     ActionId                    actionId;
00089 };
00090 
00092 
00093 
00094 // Extracts the ID of an ActionContext object (needed by EventSystem)
00095 template <typename ActionId>
00096 ActionId getEventId(const ActionContext<ActionId>& event)
00097 {
00098     return event.actionId;
00099 }
00100 
00101 } // namespace thor
00102 
00103 #endif // THOR_ACTIONCONTEXT_HPP