MezzanineEngine March 18, 2012

Mezzanine::EventManager Class Reference

This is a container for Events and facilitates the transfer of data. More...

#include <eventmanager.h>

Inheritance diagram for Mezzanine::EventManager:
Mezzanine::ManagerBase Mezzanine::Singleton< EventManager >

List of all members.

Public Member Functions

 EventManager ()
 Default constructor.
 ~EventManager ()
 Default Deconstructor.
void AddEvent (EventBase *EventToAdd)
 Adds an event of any kind to the end of the Event Queue.
void AddPollingCheck (const MetaCode &InputToTryPolling)
 Generates extra events each iteration of the main loop, based on user input polling.
void DetectJoysticks ()
 Look for Joysticks that are hooked up to the system.
virtual void DoMainLoopItems ()
 Empty MainLoopItems.
std::list< EventCollision * > * GetAllCollisionEvents ()
 This returns a complete list of all the Collision Events.
std::list< EventGameWindow * > * GetAllGameWindowEvents ()
 This returns a complete list of all the Render Time events.
std::list< EventQuit * > * GetAllQuitEvents ()
 This returns a complete list of all the quit events.
std::list< EventRenderTime * > * GetAllRenderTimeEvents ()
 This returns a complete list of all the Render Time events.
std::list< EventBase * > * GetAllSpecificEvents (EventBase::EventType SpecificType)
 This returns a complete list of all the specified events.
std::list< EventUserInput * > * GetAllUserInputEvents ()
 This returns a complete list of all the User Input events.
EventCollisionGetNextCollisionEvent ()
 Returns a pointer to the Next Collision event.
EventBaseGetNextEvent ()
 Return a pointer to the Next event.
EventGameWindowGetNextGameWindowEvent ()
 Returns a pointer to the Next GameWindow event.
EventQuitGetNextQuitEvent ()
 Returns a pointer to the Next EventQuit.
EventRenderTimeGetNextRenderTimeEvent ()
 Returns a pointer to the Next Rendertime event.
EventBaseGetNextSpecificEvent (EventBase::EventType SpecificType)
 Returns a pointer to the Next kind event of the Specified type.
EventUserInputGetNextUserInputEvent ()
 Returns a pointer to the Next User Input event.
size_t GetRemainingEventCount ()
 Gets a count of events.
virtual ManagerTypeName GetType () const
 This returns the type of this manager.
virtual void Initialize ()
 Empty Initializer.
EventCollisionPopNextCollisionEvent ()
 Returns a pointer to the Next Collision event and removes it from the Que.
EventBasePopNextEvent ()
 Return a pointer to the Next event, and removes the Event from storage.
EventGameWindowPopNextGameWindowEvent ()
 Returns a pointer to the Next GameWindow event and removes it from the Que.
EventQuitPopNextQuitEvent ()
 Returns a pointer to the Next EventQuit and removes it from the Que.
EventRenderTimePopNextRenderTimeEvent ()
 Returns a pointer to the Next Rendertime event and removes it from the Que.
EventBasePopNextSpecificEvent (EventBase::EventType SpecificType)
 Returns a pointer to the Next kind event of the Specified type, and removes it from the Que.
EventUserInputPopNextUserInputEvent ()
 Returns a pointer to the Next User Input event and removes it from the Que.
void RemoveAllSpecificEvents (EventBase::EventType SpecificType)
 This removes all the events of the specified type.
void RemoveEvent (EventBase *EventToRemove)
 Removes an event of any kind from the Event Queue.
void RemoveNextCollisionEvent ()
 Removes the First Collision Event From the que without looking at it.
void RemoveNextEvent ()
 Removes an Event From the que without looking at it.
void RemoveNextGameWindowEvent ()
 Removes the First GameWindow Event From the que without looking at it.
void RemoveNextQuitEvent ()
 Removes the First EventQuit From the que without looking at it.
void RemoveNextRenderTimeEvent ()
 Removes the First Rendertime Event From the que without looking at it.
void RemoveNextSpecificEvent (EventBase::EventType SpecificType)
 Returns a pointer to the Next kind event of the Specified type, and removes it from the Que.
void RemoveNextUserInputEvent ()
 Removes the First User Input Event From the que without looking at it.
void RemovePollingCheck (const MetaCode &InputToStopPolling)
 Removes Events from the list(s) of what needs to be polled.
void UpdateEvents ()
 Pulls Events from the all the subsystems for use in the EventManager.

Friends

std::ostream & MEZZ_LIB::operator<< (std::ostream &stream, const Mezzanine::EventManager &Mgr)
void MEZZ_LIB::operator>> (const Mezzanine::xml::Node &OneNode, Mezzanine::EventManager &Mgr)
std::istream & MEZZ_LIB::operator>> (std::istream &stream, Mezzanine::EventManager &Mgr)

Detailed Description

This is a container for Events and facilitates the transfer of data.

The Event Manager Exists to passed important information about Gamestate from where it is generated to where it is needed. It is the Game Developers option whether they want to grab events directly using the get functions that have filters, or if they want to get all the events at once from a central location and dispatch form there.
Since all User input comes in the form of events, this is also where user input Polling and optional input sources like Joysticks are controlled from.
All of these event are stored in an internal Queue and order is preserved. So the First item In will be the First Out (FIFO). This is not strictly a FIFO buffer, there are a number of functions for getting of managing specific kinds of events. Generally these 'Filtered' management functions Still return the first of those kinds of event.

Warning:
Delete pointers you get from this. Anything can create events and Put them here, and anything can get them out, This means the simple way to not cause memory leaks is to have the routines extracting the events delete the events.
Currently this is not thread safe, even though it should be.

Definition at line 123 of file eventmanager.h.


Constructor & Destructor Documentation

Mezzanine::EventManager::EventManager ( )

Default constructor.

This creates an empty EventManger

Todo:
TODO: Make the EventManager completely thread safe. IF this is completely thread safe, we can spawn numerous individual thread each accessing this and and the performance gain would almost scale directly with cpu core count increases. Look at boost scoped_lock

Definition at line 254 of file eventmanager.cpp.

Mezzanine::EventManager::~EventManager ( )

Default Deconstructor.

This deletes everything still in the event manager and tears it down.

Definition at line 265 of file eventmanager.cpp.


Member Function Documentation

void Mezzanine::EventManager::AddEvent ( EventBase EventToAdd)

Adds an event of any kind to the end of the Event Queue.

Parameters:
EventToAddThis is a pointer to an Event.

This adds the existing event to the Queue. Be careful this is not delete, and does not go out of scope. Deleting the Event is now the responsibilty of the code that pulls it out of Event Manager.

Definition at line 318 of file eventmanager.cpp.

void Mezzanine::EventManager::AddPollingCheck ( const MetaCode InputToTryPolling)

Generates extra events each iteration of the main loop, based on user input polling.

Parameters:
InputToTryPollingThis accepts a MetaCode and will try to watch for occurences like this one

This will trigger the input system to generate an event (or add to an exiting event) when polling for the given kind of event. Each Iteration of the main loop there will be a EventUserInput that created. That Event will Include all the normal metacodes for user input that happened, and it will also have a meta code for each time this function was called. The added metacode may be partialky ignored, the Metavalue is almost always ignored, and in a situation where the can only be one of a given input on a system, the ID is ignore and 0 is assumed.

Exceptions:
Unsupported Polling Check on this PlatformWhen the metacode passed cannot be polled on this platform

Definition at line 631 of file eventmanager.cpp.

void Mezzanine::EventManager::DetectJoysticks ( )

Look for Joysticks that are hooked up to the system.

Currently this will only find the first joystick. This only needs to be done once after the joystick has been connected and detected/configured by the operating system. Joystick events may not be added if this has not been called. The is called once at when the Event manager is contructed, but if the joystick was not connected yet then it might not be found.

Definition at line 277 of file eventmanager.cpp.

void Mezzanine::EventManager::DoMainLoopItems ( ) [virtual]

Empty MainLoopItems.

This class implements this for the sake of entension and compatibility this function does nothing. This is just empty during this round of refactoring, and this will get all the functionality that currently should be here, but is in the world

Implements Mezzanine::ManagerBase.

Definition at line 669 of file eventmanager.cpp.

std::list< EventCollision * > * Mezzanine::EventManager::GetAllCollisionEvents ( )

This returns a complete list of all the Collision Events.

This finds all the Collision Events then creates a new list and returns that. This runs in linear time relative to the amounts of events.

Returns:
This returns a list<EventCollision*> pointer which is this a subset of this classes event pointer list. Use this carefully, it can cause errors if used improperly. This list pointer must be deleted, but not the events in it.

Definition at line 563 of file eventmanager.cpp.

std::list< EventGameWindow * > * Mezzanine::EventManager::GetAllGameWindowEvents ( )

This returns a complete list of all the Render Time events.

This finds all the EventUserInput Events then creates a new list and returns that. This runs in linear time relative to the amounts of events.

Returns:
This returns a list<EventGameWindow*> pointer which is this a subset of this classes event pointer list. Use this carefully, it can cause errors if used improperly. This list pointer must be deleted, but not the events in it.

Definition at line 579 of file eventmanager.cpp.

std::list< EventQuit * > * Mezzanine::EventManager::GetAllQuitEvents ( )

This returns a complete list of all the quit events.

This finds all the EventQuit Events then creates a new list and returns that. This runs in linear time relative to the amounts of events.

Warning:
Something is wrong if you have more than a few quit events. These should be checked for in each iteration of the main loop.
Returns:
This returns a std::list<EventQuit*> pointer which is this a subset of this classes event pointer list. Use this carefully, it can cause errors if used improperly. Additionally this list pointer must be deleted, but not the events in it.

Definition at line 625 of file eventmanager.cpp.

std::list< EventRenderTime * > * Mezzanine::EventManager::GetAllRenderTimeEvents ( )

This returns a complete list of all the Render Time events.

This finds all the EventRenderTime Events then creates a new list and returns that. This runs in linear time relative to the amounts of events.

Returns:
This returns a list<EventRenderTime*> pointer which is this a subset of this classes event pointer list. Use this carefully, it can cause errors if used improperly. Additionally this list pointer must be deleted, but not the events in it.

Definition at line 594 of file eventmanager.cpp.

std::list< EventBase * > * Mezzanine::EventManager::GetAllSpecificEvents ( EventBase::EventType  SpecificType)

This returns a complete list of all the specified events.

This finds all the events that are of the specified type in the event manager, then creates a new list and return that. This runs in linear time relative to the amounts of events.

Warning:
The pointers contained in this list must be used carefully. Do not delete them, this will cause errors.
Returns:
This returns a std::list<EventBase*> pointer which is this a subset of this classes event pointer list. Use this carefully, it can cause errors if used improperly. Additionally this list pointer must be deleted, but not the events in it.

Definition at line 526 of file eventmanager.cpp.

std::list< EventUserInput * > * Mezzanine::EventManager::GetAllUserInputEvents ( )

This returns a complete list of all the User Input events.

This finds all the EventUserInput Events then creates a new list and returns that. This runs in linear time relative to the amounts of events.

Returns:
This returns a std::list<EventUserInput*> pointer which is this a subset of this classes event pointer list. Use this carefully, it can cause errors if used improperly. Additionally this list pointer must be deleted, but not the events in it.

Definition at line 609 of file eventmanager.cpp.

EventCollision * Mezzanine::EventManager::GetNextCollisionEvent ( )

Returns a pointer to the Next Collision event.

This Filtered event management function returns a pointer to the next Collision event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no Collision events in the queue.

Returns:
A pointer to a EventCollision, that still needs to be removed from the event manager and deleted.

Definition at line 554 of file eventmanager.cpp.

EventBase * Mezzanine::EventManager::GetNextEvent ( )

Return a pointer to the Next event.

This returns a pointer to the next Event. It is advisable to use this for performance reasons because it runs in constant time. However it does not return a specific kind of event, and must be cast in order to use the true content. This returns a pointer to 0 if there are no events in the queue.

Returns:
A pointer to a Event, that still needs to be removed from the event manager and deleted.

Definition at line 298 of file eventmanager.cpp.

EventGameWindow * Mezzanine::EventManager::GetNextGameWindowEvent ( )

Returns a pointer to the Next GameWindow event.

This Filtered event management function returns a pointer to the next GameWindow event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no GameWindow events in the que.

Returns:
A pointer to a EventGameWindow, that still needs to be removed from the event manager and deleted.

Definition at line 570 of file eventmanager.cpp.

EventQuit * Mezzanine::EventManager::GetNextQuitEvent ( )

Returns a pointer to the Next EventQuit.

This Filtered event management function returns a pointer to the next EventQuit. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no EventQuit events in the que.

Returns:
A pointer to a EventQuit, that still needs to be removed from the event manager and deleted.

Definition at line 616 of file eventmanager.cpp.

EventRenderTime * Mezzanine::EventManager::GetNextRenderTimeEvent ( )

Returns a pointer to the Next Rendertime event.

This Filtered event management function returns a pointer to the next Rendertime event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no EventRenderTime events in the que.

Returns:
A pointer to a EventRenderTime, that still needs to be removed from the event manager and deleted.

Definition at line 585 of file eventmanager.cpp.

EventBase * Mezzanine::EventManager::GetNextSpecificEvent ( EventBase::EventType  SpecificType)

Returns a pointer to the Next kind event of the Specified type.

Parameters:
SpecificTypeThis is a Event::EventType that defines the type you want this to work with

This and the other NextSpecificEvent functions are the core of the Event Filtering System. In general the other filtering functions call one of these and does very little work on their own.
This performs a linear search starting with the oldest (first entered Events) and simply checks if it the of the correct type. Then this returns a pointer to the next event of the specified type, or returns a pointer to 0 if there are none of the correct pointers in the Que. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events.

Returns:
A pointer to a EventUserInput, that still needs to be removed from the event manager and deleted.

Definition at line 488 of file eventmanager.cpp.

EventUserInput * Mezzanine::EventManager::GetNextUserInputEvent ( )

Returns a pointer to the Next User Input event.

This Filtered event management function returns a pointer to the next User Input event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no User Input events in the que.

Returns:
A pointer to a EventUserInput, that still needs to be removed from the event manager and deleted.

Definition at line 600 of file eventmanager.cpp.

size_t Mezzanine::EventManager::GetRemainingEventCount ( )

Gets a count of events.

This returns a total count of all events stored in this EventManager.

Returns:
This returns an unsigned integer with the amount of of total events

Definition at line 295 of file eventmanager.cpp.

ManagerBase::ManagerTypeName Mezzanine::EventManager::GetType ( ) const [virtual]

This returns the type of this manager.

Returns:
This returns ManagerTypeName::EventManager

Implements Mezzanine::ManagerBase.

Definition at line 675 of file eventmanager.cpp.

void Mezzanine::EventManager::Initialize ( ) [virtual]

Empty Initializer.

This specific initializor is unneeded, but we implement it for compatibility. It also exists in case a derived class wants to override it for some reason

Implements Mezzanine::ManagerBase.

Definition at line 666 of file eventmanager.cpp.

EventCollision * Mezzanine::EventManager::PopNextCollisionEvent ( )

Returns a pointer to the Next Collision event and removes it from the Que.

This Filtered event management function returns a pointer to the next Collision event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no Collision events in the que. This also removes the returned pointer form the Queue.

Returns:
A pointer to a EventRenderTime, that still needs to be removed from the event manager and deleted.

Definition at line 557 of file eventmanager.cpp.

EventBase * Mezzanine::EventManager::PopNextEvent ( )

Return a pointer to the Next event, and removes the Event from storage.

This functions just like GetNextEvent , except that it also removes the item from the internal storage of the EventManager. This returns a pointer to 0 if there are no events in the que.

Returns:
A pointer to a Event, that will need to be deleted once it has been used.

Definition at line 306 of file eventmanager.cpp.

EventGameWindow * Mezzanine::EventManager::PopNextGameWindowEvent ( )

Returns a pointer to the Next GameWindow event and removes it from the Que.

This Filtered event management function returns a pointer to the next GameWindow event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no GameWindow events in the que. This also removes the returned pointer form the Que.

Returns:
A pointer to a EventRenderTime, that still needs to be removed from the event manager and deleted.

Definition at line 573 of file eventmanager.cpp.

EventQuit * Mezzanine::EventManager::PopNextQuitEvent ( )

Returns a pointer to the Next EventQuit and removes it from the Que.

This Filtered event management function returns a pointer to the next EventQuit. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no EventQuit events in the que. This also removes the returned pointer form the Que.

Returns:
A pointer to a EventQuit, that still needs to be removed from the event manager and deleted.

Definition at line 619 of file eventmanager.cpp.

EventRenderTime * Mezzanine::EventManager::PopNextRenderTimeEvent ( )

Returns a pointer to the Next Rendertime event and removes it from the Que.

This Filtered event management function returns a pointer to the next Rendertime event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no rendertime events in the que. This also removes the returned pointer form the Que.

Returns:
A pointer to a EventRenderTime, that still needs to be removed from the event manager and deleted.

Definition at line 588 of file eventmanager.cpp.

EventBase * Mezzanine::EventManager::PopNextSpecificEvent ( EventBase::EventType  SpecificType)

Returns a pointer to the Next kind event of the Specified type, and removes it from the Que.

Parameters:
SpecificTypeThis is a Event::EventType that defines the type you want this to work with

This is just like GetNextSpecificEvent(Event::EventType SpecificType) but it also removes the item from the Que.

Returns:
A pointer to a EventUserInput, that still needs to be removed from the event manager and deleted.

Definition at line 502 of file eventmanager.cpp.

EventUserInput * Mezzanine::EventManager::PopNextUserInputEvent ( )

Returns a pointer to the Next User Input event and removes it from the Que.

This Filtered event management function returns a pointer to the next User Input event. It is inadvisable to use this for performance reasons because it runs in linear time relative to the amount of events. However, it will return an immediately usable pointer for case where an extreme level of performance is not required. This returns a pointer to 0 if there are no User Input events in the que. This also removes the returned pointer form the Que.

Returns:
A pointer to a EventUserInput, that still needs to be removed from the event manager and deleted.

Definition at line 603 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveAllSpecificEvents ( EventBase::EventType  SpecificType)

This removes all the events of the specified type.

This finds all the events that are of the specified type in the event manager, then removes them.

Warning:
This does not delete the events. This is a memory leak unless used with GetAllSpecificEvents so that the events can be tracked indeendantly, and deleted.

Definition at line 540 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveEvent ( EventBase EventToRemove)

Removes an event of any kind from the Event Queue.

Parameters:
EventToRemovePointer to the event that will be removed.

In most cases you will want to use the PopNextEvent() methods when going through events. In some expert use cases however you may want to remove a specific event at an arbitrary place in the Queue. This is the method for doing so.

Definition at line 321 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextCollisionEvent ( )

Removes the First Collision Event From the que without looking at it.

This together with GetNextCollisionEvent() are the pretty much same as call PopNextCollisionEvent().

Warning:
If you did not call GetNextCollisionEvent() and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately.
Exceptions:
Thiscan throw any STL exception a queue could. And with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 560 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextEvent ( )

Removes an Event From the que without looking at it.

This together with GetNextEvent() are the same as call PopNextEvent().

Warning:
If you did not call GetNextEvent() and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately
Exceptions:
Thiscan throw any STL exception a que could. Any with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 315 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextGameWindowEvent ( )

Removes the First GameWindow Event From the que without looking at it.

This together with GetNextGameWindowEvent() are the pretty much same as call PopNextGameWindowEvent().

Warning:
If you did not call GetNextGameWindowEvent() and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately
Exceptions:
Thiscan throw any STL exception a queue could. And with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 576 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextQuitEvent ( )

Removes the First EventQuit From the que without looking at it.

This together with GetNextQuitEvent() are the pretty much same as call PopNextQuitEvent().

Warning:
If you did not call GetNextQuitEvent() and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately
Exceptions:
Thiscan throw any STL exception a queue could. And with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 622 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextRenderTimeEvent ( )

Removes the First Rendertime Event From the que without looking at it.

This together with GetNextRenderTimeEvent() are the pretty much same as call PopNextRenderTimeEvent().

Warning:
If you did not call GetNextRenderTimeEvent() and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately
Exceptions:
Thiscan throw any STL exception a queue could. And with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 591 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextSpecificEvent ( EventBase::EventType  SpecificType)

Returns a pointer to the Next kind event of the Specified type, and removes it from the Que.

Parameters:
SpecificTypeThis is a Event::EventType that defines the type you want this to work with

This is just like PopNextSpecificEvent(Event::EventType SpecificType) but exept it doesn't bother with any of the needed structure involved with returning data, and just removes the specific event from the Queue.

Warning:
If you did not call GetNextSpecificEvent(Event::EventType SpecificType) and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately.
Exceptions:
Thiscan throw any STL exception a queue could. And with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 517 of file eventmanager.cpp.

void Mezzanine::EventManager::RemoveNextUserInputEvent ( )

Removes the First User Input Event From the que without looking at it.

This together with GetNextUserInputEvent() are the pretty much same as call PopNextUserInputEvent().

Warning:
If you did not call GetNextUserInputEvent() and haven't deleted or stored, or somehow dealt with this pointer, then this is a memory leak. Don't use this unless you are certain you have taken care of the pointer appropriately
Exceptions:
Thiscan throw any STL exception a queue could. And with likely throw some kind of except if called when there are no Events in the Que.

Definition at line 606 of file eventmanager.cpp.

void Mezzanine::EventManager::RemovePollingCheck ( const MetaCode InputToStopPolling)

Removes Events from the list(s) of what needs to be polled.

Parameters:
InputToStopPollingThis accepts a MetaCode and will try to Remove Watches like this one

This will remove any check for polling that share the same inputcode and ID. This

Exceptions:
Polling check not presentIs thrown

Definition at line 641 of file eventmanager.cpp.

void Mezzanine::EventManager::UpdateEvents ( )

Pulls Events from the all the subsystems for use in the EventManager.

The work this function does is already performed in the main loop. This only really needs to be used If a game developer chooses to use his own main loop. This adds system events, like EventQuit and Other Windows manager events, and if any user input event actions, this generates one EventUserInput that stores everythin that happened.

Definition at line 333 of file eventmanager.cpp.


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Defines