moved event handling into Modules instead of having seperate event listener objects

.hgignore

@@ -9,7 +9,7 @@ Makefile
 
 start
 runtests
-hasteroids
+run_asteroids
 
 ./doc/html/*
 

asteroids/ControllerCommands.cc

@@ -3,7 +3,7 @@
 #include "Controller.h"
 #include "Model.h"
 #include "EntityBase.h"
-#include "EventsBase.h"
+#include "EventBase.h"
 
 #include "Controller.h"
 #include "ShipEntity.h"

asteroids/Model.cc

@@ -57,17 +57,33 @@ int Model::OnInit (int argc, char* argv[]) {
 	}
 
 	// initialize event handlers and register them
-	mLevelCompleteEventHandler = new LevelCompleteEventHandler (this);
+	Engine::RegisterListener (this, EventLevelComplete);
-	Engine::RegisterListener (mLevelCompleteEventHandler, EventLevelComplete);
+	Engine::RegisterListener (this, EventGameOver);
-
-	mGameOverEventHandler = new GameOverEventHandler (this);
-	Engine::RegisterListener (mGameOverEventHandler, EventGameOver);
 
 	mPlayerName = "Player";
 
 	return result;
 }
 
+bool Model::OnReceiveEvent (const Engine::EventBasePtr &event) {
+	switch (event->mEventType) {
+		case EventLevelComplete:
+			return OnLevelComplete();
+			break;
+		case EventGameOver:
+			return OnGameOver();
+			break;
+
+		default: Engine::LogWarning ("Received Event with type %d but don't know what to do with it!", event->mEventType);
+						 break;
+	}
+
+	return false;
+}
+
+/*
+ * Module specific functions
+ */
 void Model::Process () {
 	if (mLastGameState == mGameState) {
 		if (mGameState == GameStateRunning) {

asteroids/Model.h

@@ -50,8 +50,6 @@ class Model : public Engine::ModelBase {
 			mAsteroids.clear();
 			mLevelList.clear();
 			SaveHighscoreList();
-			delete mLevelCompleteEventHandler;
-			delete mGameOverEventHandler;
 		};
 		virtual void OnRegisterCommands ();
 
@@ -70,32 +68,7 @@ class Model : public Engine::ModelBase {
 		std::string mPlayerName;
 		std::vector<std::string> mLevelList;
 
-		/* event handler class definitions */
+		virtual bool OnReceiveEvent (const Engine::EventBasePtr &event);
-		class LevelCompleteEventHandler : public Engine::EventListenerBase {
-			public:
-				explicit LevelCompleteEventHandler (Model *view) : mModel (view) {};
-				virtual bool HandleEvent (const Engine::EventBasePtr &event) const {
-					return mModel->OnLevelComplete();
-				}
-			private:
-				LevelCompleteEventHandler() {};
-				Model *mModel;
-		};
-
-		class GameOverEventHandler : public Engine::EventListenerBase {
-			public:
-				explicit GameOverEventHandler (Model *view) : mModel (view) {};
-				virtual bool HandleEvent (const Engine::EventBasePtr &event) const {
-					return mModel->OnGameOver();
-				}
-			private:
-				GameOverEventHandler() {};
-				Model *mModel;
-		};
-
-		/* event handler member variables */
-		LevelCompleteEventHandler *mLevelCompleteEventHandler;
-		GameOverEventHandler *mGameOverEventHandler;
 
 	friend class View;
 };

asteroids/View.cc

@@ -6,7 +6,7 @@
 #include "Engine.h"
 #include "Physics.h"
 #include "Model.h"
-#include "EventsBase.h"
+#include "EventBase.h"
 
 #include "ShipEntity.h"
 #include "AsteroidEntity.h"
@@ -78,38 +78,32 @@ int View::OnInit (int argc, char* argv[]) {
 	mShipPartsSprite.LoadFromPNG ("./data/textures/ship_parts.png");
 	mShipPartsSprite.SetSubSpriteCount (10);
 
-	mAccelerateEventHandler = new AccelerateEventHandler (this);
+	Engine::RegisterListener (this, EventAccelerateStart);
-	Engine::RegisterListener (mAccelerateEventHandler, EventAccelerateStart);
+	Engine::RegisterListener (this, EventAccelerateStop);
-	Engine::RegisterListener (mAccelerateEventHandler, EventAccelerateStop);
+	Engine::RegisterListener (this, EventShipExplode);
-
-	mShipExplodeEventHandler = new ShipExplodeEventHandler (this);
-	Engine::RegisterListener (mShipExplodeEventHandler, EventShipExplode);
 
 	return 0;
 }
 
 void View::OnDestroy() {
-	delete mAccelerateEventHandler;
-	delete mShipExplodeEventHandler;
-
 	mBackgroundStars.clear();
 	mShipPartsEntityIds.clear();
 
 	Engine::ViewBase::OnDestroy();
 }
 
-/*
+bool View::OnReceiveEvent (const Engine::EventBasePtr &event) {
- * Event Handlers
+	switch (event->mEventType) {
- */
+		case EventAccelerateStart:
-bool View::AccelerateEventHandler::HandleEvent (const Engine::EventBasePtr &event) const {
+		case EventAccelerateStop:
 			if (event->mEventType == EventAccelerateStart)
-		mView->mShipThrustSprite.ResetAnimation();
+				mShipThrustSprite.ResetAnimation();
 
 			Engine::LogDebug ("Received Acceleration Event: %d", event->mEventType);
 			return true;
-}
 
-bool View::ShipExplodeEventHandler::HandleEvent (const Engine::EventBasePtr &event) const {
+			break;
+		case EventShipExplode:
 			if (event->mEventType == EventShipExplode) {
 				Engine::EntityBase *ship_entity = Engine::GetEntity (event->mEventUnsignedInt);
 				vector3d position = ship_entity->mPhysicState->mPosition;
@@ -117,9 +111,9 @@ bool View::ShipExplodeEventHandler::HandleEvent (const Engine::EventBasePtr &eve
 				vector3d velocity = ship_entity->mPhysicState->mVelocity;
 
 				unsigned int i;
-		mView->mShipPartsEntityIds.clear();
+				mShipPartsEntityIds.clear();
 
-		for (i = 0; i < mView->mShipPartsSprite.GetSubSpriteCount(); i++) {
+				for (i = 0; i < mShipPartsSprite.GetSubSpriteCount(); i++) {
 					Engine::EntityBase* part_sprite_particle = Engine::CreateEntity (GameEntityTypeShipPart);
 					part_sprite_particle->mPhysicState->mPosition = position;
 					part_sprite_particle->mPhysicState->mOrientation = orientation;
@@ -127,12 +121,21 @@ bool View::ShipExplodeEventHandler::HandleEvent (const Engine::EventBasePtr &eve
 					part_sprite_particle->mPhysicState->mVelocity = vector3d (velocity[0] * (rand()/float(RAND_MAX)) * 1.7, 0., velocity[2] * (rand()/float(RAND_MAX)) * 1.5);
 					part_sprite_particle->mPhysicState->mAngleVelocity = (rand()/float(RAND_MAX) - 0.5 ) * 100.;
 
-			mView->mShipPartsEntityIds.push_back(part_sprite_particle->mId);
+					mShipPartsEntityIds.push_back(part_sprite_particle->mId);
 				}
 			}
 
 			Engine::LogDebug ("Received Ship Explode Event: %d", event->mEventType);
 			return true;
+
+
+			break;
+
+		default: Engine::LogWarning ("Received Event with type %d but don't know what to do with it!", event->mEventType);
+						 break;
+	}
+
+	return false;
 }
 
 /*

asteroids/View.h

@@ -54,26 +54,7 @@ class View : public Engine::ViewBase {
 		Engine::Sprite mShipThrustSprite;
 		Engine::Sprite mShipPartsSprite;
 
-		class AccelerateEventHandler : public Engine::EventListenerBase {
+		virtual bool OnReceiveEvent (const Engine::EventBasePtr &event);
-			public:
-				explicit AccelerateEventHandler (View *view) : mView (view) {};
-				virtual bool HandleEvent (const Engine::EventBasePtr &event) const;
-			private:
-				View *mView;
-		};
-
-		class ShipExplodeEventHandler : public Engine::EventListenerBase {
-			public:
-				explicit ShipExplodeEventHandler (View *view) : mView (view) {};
-				virtual bool HandleEvent (const Engine::EventBasePtr &event) const;
-			private:
-				View *mView;
-		};
-
-		AccelerateEventHandler *mAccelerateEventHandler;
-		ShipExplodeEventHandler *mShipExplodeEventHandler;
-
-		friend class AccelerateEventHandler;
 };
 
 }

engine/CMakeLists.txt

@@ -22,7 +22,7 @@ SET ( ENGINE_SRCS
 	PhysicsBase.cc
 	PhysicsEntityBase.cc
 	ViewBase.cc
-	EventsBase.cc
+	EventBase.cc
 	OverlayBase.cc
 
 	Commands.cc

engine/Engine.cc

@@ -11,7 +11,7 @@
 #include "ControllerBase.h"
 
 #include "EntityFactoryBase.h"
-#include "EventsBase.h"
+#include "EventManager.h"
 
 #include <iostream>
 #include <cstdio>

engine/Engine.h

@@ -154,6 +154,6 @@ ControllerBase* EngineGetController ();
 #include "CommandsGlobal.h"
 #include "ModelBaseGlobal.h"
 #include "ViewBaseGlobal.h"
-#include "EventsBaseGlobal.h"
+#include "EventBaseGlobal.h"
 
 #endif // _ENGINE_H

engine/EventBase.cc

@@ -1,4 +1,5 @@
-#include "EventsBase.h"
+#include "EventBase.h"
+#include "EventManager.h"
 #include "Logging.h"
 
 namespace Engine {
@@ -15,10 +16,10 @@ void EventManager::OnDestroy() {
 	EventManagerInstance = NULL;
 }
 
-bool EventManager::RegisterListener (const EventListenerBase *listener, const int event_type) {
+bool EventManager::RegisterListener (Module *listener_module, const int event_type) {
-	LogDebug ("Registering Event listener %x for event type %d", listener, event_type);
+	LogDebug ("Registering Event listener %x for event type %d", listener_module, event_type);
 
-	mEventTypeListeners[event_type].push_back(listener);
+	mEventTypeListeners[event_type].push_back(listener_module);
 	return true;
 }
 
@@ -42,9 +43,9 @@ bool EventManager::TriggerEvent (const EventBasePtr &event) {
 	if (!HasEventTypeListener (event->mEventType))
 		return false;
 
-	std::vector<const EventListenerBase*>::iterator listener_iter = mEventTypeListeners[event->mEventType].begin();
+	std::vector<Module*>::iterator listener_iter = mEventTypeListeners[event->mEventType].begin();
 	for ( ; listener_iter != mEventTypeListeners[event->mEventType].end(); listener_iter++) {
-		if ((*listener_iter)->HandleEvent (event))
+		if ((*listener_iter)->SendEvent (event))
 			return true;
 	}
 
@@ -55,13 +56,13 @@ bool EventManager::TriggerEvent (const EventBasePtr &event) {
  * Global Functions
  */
 /** \brief Registers a listener to a given event type */
-bool RegisterListener (const EventListenerBase *listener, const int event_type) {
+bool RegisterListener (Module *listener_module, const int event_type) {
 	if (!EventManagerInstance) {
-		LogError ("Could not register EventListenerBase: EventManager not initialized!");
+		LogError ("Could not register Module: EventManager not initialized!");
 		return false;
 	}
 
-	return EventManagerInstance->RegisterListener (listener, event_type);
+	return EventManagerInstance->RegisterListener (listener_module, event_type);
 }
 
 /** \brief Calls all event listeners to handle the events */

engine/EventBase.h

@@ -0,0 +1,32 @@
+#ifndef EVENTSBASE_H
+#define EVENTSBASE_H
+
+// #include "Module.h"
+
+#include <boost/shared_ptr.hpp>
+
+#include <string>
+#include <map>
+#include <vector>
+#include <queue>
+
+namespace Engine {
+
+class Module;
+
+/** \brief Contains all information relevant to the Event */
+struct EventBase {
+	int mEventType;
+
+	/** \brief This might later be used for de-/serializing of the event data */
+	std::string mEventData;
+	float mEventFloat;
+	int mEventInt;
+	unsigned int mEventUnsignedInt;
+};
+
+typedef boost::shared_ptr<EventBase> EventBasePtr;
+
+}
+
+#endif /* EVENTSBASE_H */

engine/EventBaseGlobal.h

@@ -1,12 +1,12 @@
 #ifndef EVENTSBASEGLOBAL_H
 #define EVENTSBASEGLOBAL_H
 
-#include "EventsBase.h"
+#include "EventBase.h"
 
 namespace Engine {
 
 /** \brief Registers a listener to a given event type */
-bool RegisterListener (const EventListenerBase *listener, const int event_type);
+bool RegisterListener (Module *listener_module, const int event_type);
 /** \brief Calls all event listeners to handle the events */
 bool QueueEvent (const EventBasePtr &event);
 /** \brief Calls the listener handlers immediately */

engine/EventManager.h

@@ -1,7 +1,7 @@
-#ifndef EVENTSBASE_H
+#ifndef EVENTSMANAGER_H
-#define EVENTSBASE_H
+#define EVENTSMANAGER_H
 
-#include "Module.h"
+// #include "Module.h"
 
 #include <boost/shared_ptr.hpp>
 
@@ -10,47 +10,20 @@
 #include <vector>
 #include <queue>
 
+#include "EventBase.h"
+#include "Module.h"
+
 namespace Engine {
 
-/** \brief Contains all information relevant to the Event */
+/** \brief Keeps track of all the Modules that registered for a given event type
-struct EventBase {
-	int mEventType;
-
-	/** \brief This might later be used for de-/serializing of the event data */
-	std::string mEventData;
-	float mEventFloat;
-	int mEventInt;
-	unsigned int mEventUnsignedInt;
-};
-
-typedef boost::shared_ptr<EventBase> EventBasePtr;
-
-/** \brief Takes care of the handling of the Event 
  *
- * Processing of the Event is done in the EventListenerBase::HandleEvent()
- * function.
- */
-class EventListenerBase {
-	public:
-		virtual ~EventListenerBase() {};
-		/** \brief Handles the Event */
-		virtual bool HandleEvent (const EventBasePtr &event) const = 0;
-		void just_for_the_vtable() {};
-
-		/** \brief For debugging */
-		std::string mName;
-};
-
-typedef boost::shared_ptr<EventListenerBase> EventListenerPtr;
-
-/** \brief Keeps track of all the EventListenerBase objects and receives Event notifications. 
  */
 class EventManager : public Module {
 	public:
 		virtual ~EventManager() {};
 
 		/** \brief Registers a listener to a given event type */
-		bool RegisterListener (const EventListenerBase *listener, const int event_type);
+		bool RegisterListener (Module *listener_module, const int event_type);
 		/** \brief Calls all event listeners to handle the events */
 		void Process ();
 		/** \brief Queues the until Process() gets called */
@@ -79,10 +52,10 @@ class EventManager : public Module {
 
 	private:
 		/** \brief Contains for each event type the list of listeners */
-		std::map <int, std::vector<const EventListenerBase*> > mEventTypeListeners;
+		std::map <int, std::vector<Module*> > mEventTypeListeners;
 		std::queue <EventBasePtr> mQueuedEvents;
 };
 
 }
 
-#endif /* EVENTSBASE_H */
+#endif /* EVENTSMANAGER_H */

engine/Module.h

@@ -1,6 +1,8 @@
 #ifndef MODULE_H
 #define MODULE_H
 
+#include "EventBase.h"
+
 namespace Engine {
 
 /** \brief Base class for the separate modules
@@ -36,6 +38,7 @@ class Module {
 		/** \brief Calls the function that registers its commands to the
 		 * Commandsystem */
 		virtual void RegisterCommands () { OnRegisterCommands (); }
+		virtual bool SendEvent (const EventBasePtr &event) { return OnReceiveEvent (event); }
 
 	protected:
 		/** \brief The actual function being called when Init () is called */
@@ -44,6 +47,8 @@ class Module {
 		virtual void OnDestroy () { };
 		/** \brief Registers the commands of the Module */
 		virtual void OnRegisterCommands () { };
+		/** \brief Reacts on a event that was sent to the module */
+		virtual bool OnReceiveEvent (const EventBasePtr &event) { return false; };
 };
 
 }

engine/libraries/coll2d/CMakeLists.txt

@@ -17,5 +17,5 @@ SET_TARGET_PROPERTIES ( ${PROJECT_EXECUTABLES} PROPERTIES
 
 SUBDIRS (tests)
 
-ADD_LIBRARY ( coll2d ${COLL2D_SRCS} )
+ADD_LIBRARY ( coll2d SHARED ${COLL2D_SRCS} )
 

engine/libraries/mathlib/CMakeLists.txt

@@ -6,5 +6,4 @@ SET ( SRCS
 	mathlib.cc
 	main.cc
 	)
-
+ADD_LIBRARY ( mathlib SHARED mathlib.cc mathlib.h)
-ADD_LIBRARY ( mathlib mathlib.cc mathlib.h)

engine/libraries/oglft/liboglft/CMakeLists.txt

@@ -23,7 +23,7 @@ IF( WIN32 )
   ADD_DEFINITIONS( -DOGLFT_BUILD )
 ENDIF( WIN32 )
 
-ADD_LIBRARY( oglft STATIC ${sources} )
+ADD_LIBRARY( oglft SHARED ${sources} )
 TARGET_LINK_LIBRARIES(
   oglft
   ${FREETYPE2_LIBRARIES}

engine/tests/CMakeLists.txt

@@ -9,7 +9,7 @@ SET ( TESTS_SRCS
 	main.cc
 	CommandsTests.cc
 	EntityTests.cc
-	EventsBaseTests.cc
+	EventBaseTests.cc
 	PhysicsTests.cc
 	ControllerBaseTests.cc
 	)

engine/tests/EventBaseTests.cc

@@ -1,7 +1,8 @@
 #include <UnitTest++.h>
 
 #include "Logging.h"
-#include "EventsBase.h"
+#include "Module.h"
+#include "EventManager.h"
 
 using namespace std;
 using namespace Engine;
@@ -9,18 +10,21 @@ using namespace Engine;
 int global_event_type = -1;
 string global_event_string = "";
 
-class TestEventListener : public EventListenerBase {
+struct EventsFixture;
-	public:
-		TestEventListener() {
-			mName = "TestEventListener";
-		}
 
-		virtual bool HandleEvent (const EventBasePtr &event) const {
+class TestEventModule : public Module {
+	private:
+		virtual int OnInit (int argc, char* argv[]) {
+			return 0;
+		};
+	virtual bool OnReceiveEvent (const EventBasePtr &event) {
 			global_event_type = event->mEventType;
 			global_event_string = event->mEventData;
 
 			return true;
 	}
+
+	friend class EventsFixture;
 };
 
 struct EventsFixture {
@@ -43,17 +47,17 @@ struct EventsFixture {
 
 	Logging LoggingModule;
 
-	TestEventListener Listener;
+	TestEventModule TestModule;
 	EventManager *TestEventManager;
 };
 
-TEST_FIXTURE ( EventsFixture, TestEventListenerHandleEvent ) {
+TEST_FIXTURE ( EventsFixture, TestEventModuleSendEvent ) {
 	EventBasePtr event (new EventBase);
 
 	event->mEventType = 1;
 	event->mEventData = "test";
 
-	Listener.HandleEvent (event);
+	TestModule.SendEvent (event);
 
 	CHECK_EQUAL (1, global_event_type);
 	CHECK_EQUAL ("test", global_event_string);
@@ -65,17 +69,17 @@ TEST_FIXTURE ( EventsFixture, TestTestEventManagerZeroListeners ) {
 }
 
 TEST_FIXTURE ( EventsFixture, TestTestEventManagerAddListener ) {
-	TestEventManager->RegisterListener (&Listener, 1);
+	TestEventManager->RegisterListener (&TestModule, 1);
 
 	CHECK_EQUAL (true, TestEventManager->HasEventTypeListener(1));
 	CHECK_EQUAL (false, TestEventManager->HasEventTypeListener(2));
 
-	TestEventManager->RegisterListener (&Listener, 1);
+	TestEventManager->RegisterListener (&TestModule, 1);
 	CHECK_EQUAL (2, TestEventManager->GetEventTypeListenerCount(1));
 }
 
 TEST_FIXTURE ( EventsFixture, TestTestEventManagerTriggerEvent ) {
-	TestEventManager->RegisterListener (&Listener, 1);
+	TestEventManager->RegisterListener (&TestModule, 1);
 
 	CHECK_EQUAL (true, TestEventManager->HasEventTypeListener(1));
 
@@ -94,7 +98,7 @@ TEST_FIXTURE ( EventsFixture, TestTestEventManagerTriggerEvent ) {
 }
 
 TEST_FIXTURE ( EventsFixture, TestTestEventManagerQueueEvent ) {
-	TestEventManager->RegisterListener (&Listener, 1);
+	TestEventManager->RegisterListener (&TestModule, 1);
 
 	EventBasePtr event (new EventBase);
 
@@ -111,7 +115,7 @@ TEST_FIXTURE ( EventsFixture, TestTestEventManagerQueueEvent ) {
 }
 
 TEST_FIXTURE ( EventsFixture, TestTestEventManagerProcess ) {
-	TestEventManager->RegisterListener (&Listener, 1);
+	TestEventManager->RegisterListener (&TestModule, 1);
 
 	EventBasePtr event (new EventBase);