Spinning Topp Logo BlackTopp Studios
inc
eventbase.h
1 // © Copyright 2010 - 2016 BlackTopp Studios Inc.
2 /* This file is part of The Mezzanine Engine.
3 
4  The Mezzanine Engine is free software: you can redistribute it and/or modify
5  it under the terms of the GNU General Public License as published by
6  the Free Software Foundation, either version 3 of the License, or
7  (at your option) any later version.
8 
9  The Mezzanine Engine is distributed in the hope that it will be useful,
10  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  GNU General Public License for more details.
13 
14  You should have received a copy of the GNU General Public License
15  along with The Mezzanine Engine. If not, see <http://www.gnu.org/licenses/>.
16 */
17 /* The original authors have included a copy of the license specified above in the
18  'Docs' folder. See 'gpl.txt'
19 */
20 /* We welcome the use of the Mezzanine engine to anyone, including companies who wish to
21  Build professional software and charge for their product.
22 
23  However there are some practical restrictions, so if your project involves
24  any of the following you should contact us and we will try to work something
25  out:
26  - DRM or Copy Protection of any kind(except Copyrights)
27  - Software Patents You Do Not Wish to Freely License
28  - Any Kind of Linking to Non-GPL licensed Works
29  - Are Currently In Violation of Another Copyright Holder's GPL License
30  - If You want to change our code and not add a few hundred MB of stuff to
31  your distribution
32 
33  These and other limitations could cause serious legal problems if you ignore
34  them, so it is best to simply contact us or the Free Software Foundation, if
35  you have any questions.
36 
37  Joseph Toppi - toppij@gmail.com
38  John Blackwood - makoenergy02@gmail.com
39 */
40 #ifndef EVENTBASE_H
41 #define EVENTBASE_H
42 
43 #include "datatypes.h"
44 
45 ///////////////////////////////////////////////////////////////////////////////
46 // This is a parent class that all events must derive from. This exists solely
47 //to normalize the output of the event manager class.
48 ///////////////////////////////////////
49 
50 namespace Mezzanine
51 {
52 
53  ///////////////////////////////////////////////////////////////////////////////
54  /// @class EventBase
55  /// @headerfile eventbase.h
56  /// @brief The base class for all events.
57  /// @details All Events used in the Event Manager, will inherit from this. While
58  /// not absolutely required by the game programmer to write their own events, it
59  /// it could be useful. Instances of this class cannot be made, and all classes
60  /// that inherit from this are expected to implement getEventType().
62  {
63  public:
64  /// @brief A listing of values that can be used to identify Events.
65  /// @details A listing of values that can be used to identify Events.
66  enum EventType
67  {
68  GameWindow, /**< Indicates the Event is a Game Window Management Event. */
69  QuitMessage, /**< Indicates the Event is a Mezzanine::EventQuit. */
70  UserInput, /**< Indicates the Event is a EventUserInput. */
71  //SystemMessage, /**< Indicates the Event has not been coded yet */
72  Other
73  };
74  // If you add an eventtype do not forget to add the appropriate functions tot he event manager and update these functions
75  //void operator >> (const Mezzanine::XML::Node& OneNode, Mezzanine::EventManager& Mgr);
76  //std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::EventBase& Ev);
77 
78 
79 
80 
81  /// @brief This will aid in identifying all classes that inherit from this class.
82  /// @details All Classes derived form this calls will return an Event::EventType that correspond the
83  /// the data/class type they actually are.
84  /// @return This returns an eventype that will correspend with the actual event type. This can be used on all
85  /// Mezzanine provided class to safely cast a pointer to the correct event type.
86  virtual EventBase::EventType GetType() const = 0;
87 
88  /// @brief Virtual Deconstructor
89  virtual ~EventBase()
90  {}
91 
92  };
93 }
94 
95 #if !(defined(SWIG) && defined(MEZZLUA51)) // Stop Swig from making lua bindings but allow other languages
96  /// @brief Serializes the passed Mezzanine::Event to XML
97  /// @param stream The ostream to send the xml to.
98  /// @param Ev the Mezzanine::Event to be serialized
99  /// @return this returns the ostream, now with the serialized data
100  std::ostream& MEZZ_LIB operator << (std::ostream& stream, const Mezzanine::EventBase& Ev);
101 #endif // \!SWIG && LUA
102 
103 
104 #endif
std::ostream & operator<<(std::ostream &stream, const Mezzanine::LinearInterpolator< T > &Lint)
Used to Serialize an Mezzanine::LinearInterpolator to a human readable stream.
Definition: interpolator.h:433
All the definitions for datatypes as well as some basic conversion functions are defined here...
virtual ~EventBase()
Virtual Deconstructor.
Definition: eventbase.h:89
EventType
A listing of values that can be used to identify Events.
Definition: eventbase.h:66
The base class for all events.
Definition: eventbase.h:61
#define MEZZ_LIB
Some platforms require special decorations to denote what is exported/imported in a share library...
The bulk of the engine components go in this namspace.
Definition: actor.cpp:56