Cocos2d-x 学习笔记(15.1) EventDispatcher
EventDispatcher对监听器进行管理,围绕着监听器工作。可以添加、删除、暂停/恢复监听器、分发事件到监听器。
1. 一些成员
/** 把ListenerID和同ID监听器的容器对应 */
std::unordered_map<EventListener::ListenerID, EventListenerVector*> _listenerMap;
/** 把listenerID的对应的DirtyFlag*/
std::unordered_map<EventListener::ListenerID, DirtyFlag> _priorityDirtyFlagMap;
/** 把node和其监听器对应 key:node, value:存储监听器的容器 */
std::unordered_map<Node*, std::vector<EventListener*>*> _nodeListenersMap;
/** key: node, value: node优先级 */
std::unordered_map<Node*, int> _nodePriorityMap;
/** key: Global Z Order, value: 同gzorder排序好的node*/
std::unordered_map<float, std::vector<Node*>> _globalZOrderNodeMap;
/** 存储待添加的监听器 The listeners to be added after dispatching event */
std::vector<EventListener*> _toAddedListeners;
/** 存储待删除的监听器 The listeners to be removed after dispatching event */
std::vector<EventListener*> _toRemovedListeners;
/** 被脏标记的node */
std::set<Node*> _dirtyNodes;
2. 添加监听器:
2.1 添加和场景图优先级一致的监听器 addEventListenerWithSceneGraphPriority(EventListener* listener, Node* node)
参数是监听器、关联的node。监听器优先级自动设为0。
2.2 添加自定优先级的监听器 addEventListenerWithFixedPriority(EventListener* listener, int fixedPriority)
参数是监听器、监听器优先级。监听器优先级自定义,不能为0。
两个添加监听器方法都执行了listener->checkAvailable(),在对监听器设置一些成员变量后,调用了addEventListener(listener),下面看addEventListener方法:
2.3.1 addEventListener
该方法用于当分发器正在分发事件时,把监听器用待添加容器存储,而不是直接加到对应的监听器容器里。因为分发事件需要遍历监听器容器,此时不应对容器修改。
当分发器没有分发时,调用forceAddEventListener(listener)方法:
2.3.2 forceAddEventListener
该方法是把监听器直接添加到监听器容器的核心方法。容器是_listenerMap,监听器ID为key,容器Vector为value。同ID的监听器被统一存储。Vector又包含了两个vector容器,根据监听器优先级是否为0存入不同vector里。
监听器优先级为0时,还要用容器建立node和监听器的关联,用容器方便其他方法获取node的所有监听器。建立关联调用associateNodeAndEventListener方法。
2.3.3 associateNodeAndEventListener
用容器_nodeListenersMap存储node关联的所有监听器。
2.4 添加自定义监听器addCustomEventListener(const std::string &eventName, const std::function<void(EventCustom*)>& callback)
参数是事件ID、回调函数。优先级自动设为1。
通过ID和回调函数建立自定义监听器对象,调用向容器添加自定优先级监听器方法,把监听器对象加入监听器容器中。
_onCustomEvent是我们指定的回调函数,_onEvent是本方法自动设置的对_onCustomEvent调用的函数,参数为分发到的事件event。
3. 删除监听器
3.1 删除指定的监听器 removeEventListener(EventListener* listener)
如果监听器在待删除容器中,直接从容器中删除。否则,在_listnerMap中遍历查找指定的监听器进行删除,分发器分发事件时,暂缓删除。
dissociateNodeAndEventListener方法,将参数node和参数监听器建立的关联,在容器_nodeListenersMap中删除。
3.2 删除指定类型的监听器 removeEventListenersForType(EventListener::Type listenerType)
该方法对参数listenerType进行判断,再调用removeEventListenersForListenerID,参数为相应监听器类型的LISTENER_ID。
被调用的removeEventListenersForListenerID方法,简要的说,是从_listenerMap查找ID对应的Vector,对Vector的两个存储监听器的容器都清空。清空的操作包括对每个监听器setRegistered(false),删除监听器和node之间的关联,执行release()。之后,删除Vector,还要从_listenerMap中删除。最后,还要从_toAddedListeners容器里删除可能存在的ID监听器。
3.3 删除指定node关联的监听器removeEventListenersForTarget(Node* target, bool recursive/* = false */)
参数为:指定的node,recursive。recursive为true,关联到node子节点的监听器也会被删除,为false则只删除与node关联的。
该方法,简要的说,首先对两个以node为key的容器_nodePriorityMap和_dirtyNodes删除key为node的entry。
再从_nodeListenersMap中找到key为node的监听器容器,对容器中每个监听器执行removeEventListener(EventListener* listener)。
另外,还要在_toAddedListeners中查找有无关联到node的监听器,如有要删除监听器,执行release()。
如果参数recursive为true,对node的所有子节点调用本方法。
3.4 删除指定ID的监听器 removeCustomEventListeners(const std::string& customEventName)
调用了removeEventListenersForListenerID(customEventName)。
3.5 删除所有监听器 removeAllEventListeners()
先获取_listenerMap中所有ID,再调用removeEventListenersForListenerID(type)删除每个ID(type)的监听器。
3.6 删除指定ID的监听器 removeEventListenersForListenerID(listenerID)
先从_listenerMap中获取ID对应的两个监听器容器,再对每个容器的每个监听器setRegistered(false)、删除与node的关联,当没有事件分发时,从容器中删除并执行release(),有事件分发时,在分发事件方法的updateListeners中删除监听器。对_listenerMap中该entry删除。最后还要在_toAddedListeners查找删除对应的监听器。
4. 暂停与恢复监听器
pauseEventListenersForTarget(Node* target, bool recursive/* = false */)
resumeEventListenersForTarget(Node* target, bool recursive/* = false */)
都是对监听器执行setPaused,设置_paused变量。恢复时对node设置脏标记。
5. 进行事件分发 dispatchEvent(Event* event)
这篇文章:事件分发机制