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;