Mezzanine::EventBase Class Reference

The base class for all events. More...

#include <eventbase.h>

Inheritance diagram for Mezzanine::EventBase:

List of all members.

Public Types
enum	EventType {   Collision, GameWindow, QuitMessage, RenderTime,   UserInput, Other }
Public Member Functions
virtual EventBase::EventType	GetType () const =0
	This will aid in identifying all classes that inherit from this class.

---

Detailed Description

The base class for all events.

All Events used in the Event Manager, will inherit from this. While not absolutely required by the game programmer to write their own events, it it could be useful. Instances of this class cannot be made, and all classes that inherit from this are expected to implement getEventType().

Definition at line 61 of file eventbase.h.

---

Member Enumeration Documentation

enum Mezzanine::EventBase::EventType

A listing of values that can be used to identify Events.

Enumerator:

Collision	Indicates the Event is a Physics Collision Event
GameWindow	Indicates the Event is a Game Window Management Event
QuitMessage	Indicates the Event is a Mezzanine::EventQuit
RenderTime	Indicates the Event is a EventRenderTime
UserInput	Indicates the Event is a EventUserInput

Definition at line 67 of file eventbase.h.

---

Member Function Documentation

virtual EventBase::EventType Mezzanine::EventBase::GetType

(

)

const [pure virtual]

This will aid in identifying all classes that inherit from this class.

All Classes derived form this calls will return an Event::EventType that correspond the the data/class type they actually are.

Returns:

This returns an eventype that will correspend with the actual event type. This can be used on all Mezzanine provided class to safely cast a pointer to the correct event type.

Implemented in Mezzanine::EventCollision, Mezzanine::EventGameWindow, Mezzanine::EventQuit, Mezzanine::EventRenderTime, and Mezzanine::EventUserInput.

---

The documentation for this class was generated from the following file:

• eventbase.h