Changeset 5888

Timestamp:

Oct 6, 2009, 4:56:42 AM (15 years ago)

Author:

landauf

Message:

Added support for named events (so one object can fire multiple different events).
Added a new class, EventFilter, to filter differently named events and map them to different states.

I've wrapped the event names with a pretty useless macro, but I want to expand this in the future and register possible event names in the Identifier of the corresponding class. This allows us to get the possible event names in a static manner and thus build an editor upon it.

Location:

code/branches/core5/src

Files:

• libraries/core/BaseObject.cc (modified) (3 diffs)
• libraries/core/BaseObject.h (modified) (1 diff)
• libraries/core/Event.h (modified) (1 diff)
• libraries/core/EventIncludes.h (modified) (1 diff)
• modules/objects/ObjectsPrereqs.h (modified) (1 diff)
• modules/objects/eventsystem/CMakeLists.txt (modified) (1 diff)
• modules/objects/eventsystem/EventFilter.cc (added)
• modules/objects/eventsystem/EventFilter.h (added)
• modules/objects/eventsystem/EventListener.cc (modified) (1 diff)
• modules/objects/eventsystem/EventName.cc (added)
• modules/objects/eventsystem/EventName.h (added)

code/branches/core5/src/libraries/core/BaseObject.cc

@@ -300 +300 @@
         @brief Fires an event (without a state).
     */
-    void BaseObject::fireEvent()
-    {
-        this->fireEvent(true);
-        this->fireEvent(false);
+    void BaseObject::fireEvent(const std::string& name)
+    {
+        this->fireEvent(true, name);
+        this->fireEvent(false, name);
     }
 
@@ -309 +309 @@
         @brief Fires an event which activates or deactivates a state.
     */
-    void BaseObject::fireEvent(bool activate)
-    {
-        this->fireEvent(activate, this);
+    void BaseObject::fireEvent(bool activate, const std::string& name)
+    {
+        this->fireEvent(activate, this, name);
     }
 
@@ -317 +317 @@
         @brief Fires an event which activates or deactivates a state with agiven originator (the object which triggered the event).
     */
-    void BaseObject::fireEvent(bool activate, BaseObject* originator)
-    {
-        Event event(activate, originator);
+    void BaseObject::fireEvent(bool activate, BaseObject* originator, const std::string& name)
+    {
+        Event event(activate, originator, name);
 
         for (std::set<BaseObject*>::iterator it = this->eventListeners_.begin(); it != this->eventListeners_.end(); ++it)

code/branches/core5/src/libraries/core/BaseObject.h

@@ -161 +161 @@
             BaseObject* getEventListener(unsigned int index) const;
 
-            void fireEvent();
-            void fireEvent(bool activate);
-            void fireEvent(bool activate, BaseObject* originator);
+            void fireEvent(const std::string& name = "");
+            void fireEvent(bool activate, const std::string& name = "");
+            void fireEvent(bool activate, BaseObject* originator, const std::string& name = "");
             void fireEvent(Event& event);
 

code/branches/core5/src/libraries/core/Event.h

@@ -40 +40 @@
     struct _CoreExport Event
     {
-        Event(bool activate, BaseObject* originator) : activate_(activate), originator_(originator) {}
+        Event(bool activate, BaseObject* originator, const std::string& name) : activate_(activate), originator_(originator), name_(name) {}
 
         bool        activate_;   //!< True if this is an activating event (the event source was inactive before and just triggered the event) - false otherwise
         std::string statename_;  //!< The name of the state this event affects
         BaseObject* originator_; //!< The object which triggered this event
+        std::string name_;       //!< The name of this event
     };
 

code/branches/core5/src/libraries/core/EventIncludes.h

@@ -68 +68 @@
     static orxonox::ExecutorMember<classname>* xmlgetfunctor##name = (orxonox::ExecutorMember<classname>*)&orxonox::createExecutor(orxonox::createFunctor(&classname::getEventSource), std::string( #classname ) + "::" + "getEventSource" + "(" + statename + ")")->setDefaultValue(1, statename); \
     XMLPortObjectGeneric(xmlport##name, classname, orxonox::BaseObject, statename, xmlsetfunctor##name, xmlgetfunctor##name, xmlelement, mode, false, true)
+    
+
+/**
+    @brief Defines a new event name for a class. Named events can only have names which were defined with this macro.
+    
+    @param classname The name of the class
+    @param name      The name of the event
+*/
+#define CreateEventName(classname, name) \
+    static std::string eventname##classname##name = #name
+
+/**
+    @brief This macro is needed to fire an event with this name. The event name must previously be declared with @ref CreateEventName.
+*/    
+#define EventName(classname, name) \
+    eventname##classname##name
  
 #endif /* _EventIncludes_H__ */

code/branches/core5/src/modules/objects/ObjectsPrereqs.h

@@ -78 +78 @@
     // eventsystem
     class EventDispatcher;
+    class EventFilter;
     class EventListener;
+    class EventName;
     class EventTarget;
 

code/branches/core5/src/modules/objects/eventsystem/CMakeLists.txt

@@ -1 +1 @@
 ADD_SOURCE_FILES(OBJECTS_SRC_FILES
   EventDispatcher.cc
+  EventFilter.cc
   EventListener.cc
+  EventName.cc
   EventTarget.cc
 )

code/branches/core5/src/modules/objects/eventsystem/EventListener.cc

@@ -63 +63 @@
 
         this->bActive_ = true;
-
-        this->fireEvent(event.activate_, event.originator_);
-
+        this->fireEvent(event.activate_, event.originator_, event.name_);
         this->bActive_ = false;
     }