CocoStudio: 触摸事件处理分析(1)

CocoStudio触摸事件处理：

1、
注册触摸事件处理函数：
方法：
    /**
     * Sets the touch event target/selector of the menu item
     */
    void addTouchEventListener(CCObject* target,SEL_TouchEvent selector);
如上面所示，我们看到这里不再像menuItem中那样，针对C++ 和 lua脚本提供了不同的，
这里只考虑lua脚本，不考虑js，因为我对js不熟，也没用过。
如CCMenuItem* CCMenuItem::create(CCObject *rec, SEL_MenuHandler selector)和
/** Register menu handler script function */
    virtual void registerScriptTapHandler(int nHandler);

那么这里是怎么把C++和lua脚本统一起来的呢？
C++部分：很清楚，不说了。
void Widget::addTouchEventListener(CCObject *target, SEL_TouchEvent selector)
{
    _touchEventListener = target;
    _touchEventSelector = selector;
}

lua脚本：
lua脚本中我们一般这样使用：
    local function rightBtnClickEvent(sender,eventType)
        if eventType == ccs.TouchEventType.ended then

        end
    end

    local rightBtn = UIHelper:seekWidgetByName(mainBg, "btn_right")
    rightBtn:addTouchEventListener(rightBtnClickEvent)

通过tolua把C++转到lua中使用：
static int tolua_Cocos2dx_Widget_addTouchEventListener00(lua_State* tolua_S)
{
#ifndef TOLUA_RELEASE
    tolua_Error tolua_err;
    if ( //对传入的参数进行检查，LUA_FUNCTION传入的必须是一个函数。
        !tolua_isusertype(tolua_S,1,"Widget",0,&tolua_err) ||
        !toluafix_isfunction(tolua_S,2,"LUA_FUNCTION",0,&tolua_err) ||
        !tolua_isnoobj(tolua_S,3,&tolua_err)
        )
        goto tolua_lerror;
    else
#endif
    {
        Widget* self = (Widget*)  tolua_tousertype(tolua_S,1,0);
#ifndef TOLUA_RELEASE
        if (!self) tolua_error(tolua_S,"invalid 'self' in function 'addTouchEventListener'", NULL);
#endif
        //创建了一个LuaCocoStudioEventListener类，这个类在lua_cocos2dx_cocostudio_manual.cpp
	//文件中定义，下面介绍：
        LuaCocoStudioEventListener* listener = LuaCocoStudioEventListener::create();
        if (NULL == listener)
        {
            tolua_error(tolua_S,"LuaCocoStudioEventListener create fail\n", NULL);
            return 0;
        }

        LUA_FUNCTION handler = (  toluafix_ref_function(tolua_S,2,0));

	//把lua脚本的回调函数，如上面的local function rightBtnClickEvent(sender,eventType)
	//通过toluafix_ref_function转化C++可以保存的变量，然后保存到listener类中的成员变量中。
        listener->setHandler(handler);

	//getScriptObjectDict是Widget的成员函数，看名字应该是保存脚本相关的对象。
        CCDictionary* dict = static_cast<CCDictionary*>(self->getScriptObjectDict());
        if (NULL == dict)
        {
            dict = CCDictionary::create();
            self->setScriptObjectDict(dict);
        }

	//把listener添加到dict中
        dict->setObject(listener, "widgetTouchEvent");

	//把我们上面创建的LuaCocoStudioEventListener对象实例listener通过addTouchEventListener函数
	//添加到控件上，这里调用的就是C++的方法。这里主要通过LuaCocoStudioEventListener类，作为一个中间介质
	//把lua和C++统一起来了。注意这里：是把listener中的eventCallbackFunc函数注册为触摸事件回调函数了。
	//后面会分析这个函数。
        self->addTouchEventListener(listener, toucheventselector(LuaCocoStudioEventListener::eventCallbackFunc));
    }
    return 0;
#ifndef TOLUA_RELEASE
tolua_lerror:
    tolua_error(tolua_S,"#ferror in function 'addTouchEventListener'.",&tolua_err);
    return 0;
#endif
}

2、当触摸事件发生时，C++如何调用到lua中注册的回调函数：
上面已经分析了，通过LuaCocoStudioEventListener这个类作为介质把lua中注册的触摸事件回调函数
转化到了C++的注册回调函数的方法。
那我们先来分析下LuaCocoStudioEventListener这个类：
class LuaCocoStudioEventListener:public CCObject
{
public:
    LuaCocoStudioEventListener();
    virtual ~LuaCocoStudioEventListener();

    static LuaCocoStudioEventListener* create();

    virtual void eventCallbackFunc(CCObject* sender,int eventType);

    void setHandler(int handler){ m_lHandler = handler; }
    int  getHandler() { return m_lHandler; }
private:
    long m_lHandler; //保存lua脚本注册的回调函数
};

LuaCocoStudioEventListener::LuaCocoStudioEventListener():m_lHandler(0)
{

}

LuaCocoStudioEventListener::~LuaCocoStudioEventListener()
{

}

LuaCocoStudioEventListener* LuaCocoStudioEventListener::create()
{
    LuaCocoStudioEventListener* listener = new LuaCocoStudioEventListener();
    if (NULL == listener)
        return NULL;

    listener->autorelease();

    return listener;
}

//上面就是把这个函数通过addTouchEventListener注册为触摸事件响应回调函数。
//所以我们如果触摸控件，那么就会发生触摸事件，然后就会回调这个函数。
//而就是在这个函数中调用lua中注册的触摸回调函数。
void LuaCocoStudioEventListener::eventCallbackFunc(CCObject* sender,int eventType)
{
    if (0 != m_lHandler)
    {
        CCLuaEngine* pEngine = CCLuaEngine::defaultEngine();
        CCLuaStack* pStack = pEngine->getLuaStack();
        pStack->pushCCObject(sender, "CCObject"); //把sender压入栈
        pStack->pushInt(eventType); //把触摸事件类型压入栈
        pStack->executeFunctionByHandler(m_lHandler, 2); //回调lua中的函数
        pStack->clean();
    }
}

3、我们返回到Widget类中，看下触摸事件如何分发和处理：
bool Widget::onTouchBegan(CCTouch *touch, CCEvent *unused_event)
{
    .....
    pushDownEvent();
    return !_touchPassedEnabled;
}

---->>这样就回调了触摸事件回调函数。
void Widget::pushDownEvent()
{
    if (_touchEventListener && _touchEventSelector)
    {
        (_touchEventListener->*_touchEventSelector)(this,TOUCH_EVENT_BEGAN);
    }
}

void Widget::onTouchMoved(CCTouch *touch, CCEvent *unused_event)
{
    .....
    moveEvent();
}
---->>>
void Widget::moveEvent()
{
    if (_touchEventListener && _touchEventSelector)
    {
        (_touchEventListener->*_touchEventSelector)(this,TOUCH_EVENT_MOVED);
    }
}

void Widget::onTouchEnded(CCTouch *touch, CCEvent *unused_event)
{
    ......
    if (focus)
    {
        releaseUpEvent();
    }
    else
    {
        cancelUpEvent();
    }
}

void Widget::onTouchCancelled(CCTouch *touch, CCEvent *unused_event)
{
    setFocused(false);
    cancelUpEvent();
}
----->>>>
void Widget::releaseUpEvent()
{
    if (_touchEventListener && _touchEventSelector)
    {
        (_touchEventListener->*_touchEventSelector)(this,TOUCH_EVENT_ENDED);
    }
}

void Widget::cancelUpEvent()
{
    if (_touchEventListener && _touchEventSelector)
    {
        (_touchEventListener->*_touchEventSelector)(this,TOUCH_EVENT_CANCELED);
    }
}

其中TOUCH_EVENT_CANCELED是枚举类型，但是传递到lua中就变成了数字如0，1，2...
typedef enum
{
    TOUCH_EVENT_BEGAN, //0
    TOUCH_EVENT_MOVED, //1
    TOUCH_EVENT_ENDED, //2
    TOUCH_EVENT_CANCELED //3
}TouchEventType;