axmol/extensions/DragonBones/event/IEventDispatcher.h

/**
 * The MIT License (MIT)
 *
 * Copyright (c) 2012-2018 DragonBones team and other contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */
#ifndef DRAGONBONES_IEVENT_DISPATCHER_H
#define DRAGONBONES_IEVENT_DISPATCHER_H

#include "../core/DragonBones.h"

DRAGONBONES_NAMESPACE_BEGIN
/**
 * - The event dispatcher interface.
 * Dragonbones event dispatch usually relies on docking engine to implement, which defines the event method to be implemented when docking the engine.
 * @version DragonBones 4.5
 * @language en_US
 */
/**
 * - 事件派发接口。
 * DragonBones 的事件派发通常依赖于对接的引擎来实现，该接口定义了对接引擎时需要实现的事件方法。
 * @version DragonBones 4.5
 * @language zh_CN
 */
class IEventDispatcher
{
    ABSTRACT_CLASS(IEventDispatcher)

public:
    /**
     * - Checks whether the object has any listeners registered for a specific type of event。
     * @param type - Event type.
     * @version DragonBones 4.5
     * @language en_US
     */
    /**
     * - 检查是否为特定的事件类型注册了任何侦听器。
     * @param type - 事件类型。
     * @version DragonBones 4.5
     * @language zh_CN
     */
    virtual bool hasDBEventListener(const std::string& type) const = 0;
    /**
     * - Dispatches an event into the event flow.
     * @param type - Event type.
     * @param eventObject - Event object.
     * @see dragonBones.EventObject
     * @version DragonBones 4.5
     * @language en_US
     */
    /**
     * - 分派特定的事件到事件流中。
     * @param type - 事件类型。
     * @param eventObject - 事件数据。
     * @see dragonBones.EventObject
     * @version DragonBones 4.5
     * @language zh_CN
     */
    virtual void dispatchDBEvent(const std::string& type, EventObject* value) = 0;
    /**
     * - Add an event listener object so that the listener receives notification of an event.
     * @param type - Event type.
     * @param listener - Event listener.
     * @param thisObject - The listener function's "this".
     * @version DragonBones 4.5
     * @language en_US
     */
    /**
     * - 添加特定事件类型的事件侦听器，以使侦听器能够接收事件通知。
     * @param type - 事件类型。
     * @param listener - 事件侦听器。
     * @param thisObject - 侦听函数绑定的 this 对象。
     * @version DragonBones 4.5
     * @language zh_CN
     */
    virtual void addDBEventListener(const std::string& type, const std::function<void(EventObject*)> & listener) = 0;
    /**
     * - Removes a listener from the object.
     * @param type - Event type.
     * @param listener - Event listener.
     * @param thisObject - The listener function's "this".
     * @version DragonBones 4.5
     * @language en_US
     */
    /**
     * - 删除特定事件类型的侦听器。
     * @param type - 事件类型。
     * @param listener - 事件侦听器。
     * @param thisObject - 侦听函数绑定的 this 对象。
     * @version DragonBones 4.5
     * @language zh_CN
     */
    virtual void removeDBEventListener(const std::string& type, const std::function<void(EventObject*)>& listener) = 0;
};

DRAGONBONES_NAMESPACE_END
#endif // DRAGONBONES_IEVENT_DISPATCHER_H