2010-07-16 11:39:21 +08:00
|
|
|
/****************************************************************************
|
2011-03-19 10:59:01 +08:00
|
|
|
Copyright (c) 2010-2011 cocos2d-x.org
|
|
|
|
Copyright (c) 2009 Valentin Milea
|
2010-07-16 11:39:21 +08:00
|
|
|
|
|
|
|
http://www.cocos2d-x.org
|
|
|
|
|
|
|
|
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 __TOUCH_DISPATHCHER_CCTOUCH_DELEGATE_PROTOCOL_H__
|
|
|
|
#define __TOUCH_DISPATHCHER_CCTOUCH_DELEGATE_PROTOCOL_H__
|
|
|
|
|
2011-06-20 17:31:38 +08:00
|
|
|
#include <string>
|
|
|
|
#include <map>
|
2011-03-07 17:11:57 +08:00
|
|
|
#include "CCObject.h"
|
2011-05-31 14:04:14 +08:00
|
|
|
#include "ccConfig.h"
|
2011-06-20 17:31:38 +08:00
|
|
|
#include "CCScriptSupport.h"
|
|
|
|
|
2010-08-04 15:46:12 +08:00
|
|
|
namespace cocos2d {
|
2010-07-16 11:39:21 +08:00
|
|
|
|
2011-04-24 15:38:03 +08:00
|
|
|
typedef enum
|
|
|
|
{
|
|
|
|
ccTouchDelegateStandardBit = 1 << 0,
|
|
|
|
ccTouchDelegateTargetedBit = 1 << 1,
|
2011-04-27 22:45:54 +08:00
|
|
|
ccTouchDelegateAllBit = (ccTouchDelegateStandardBit | ccTouchDelegateTargetedBit),
|
2010-08-27 14:13:32 +08:00
|
|
|
} ccTouchDelegateFlag;
|
|
|
|
|
2010-09-03 09:32:13 +08:00
|
|
|
class CCTouch;
|
2011-03-18 09:39:34 +08:00
|
|
|
class CCEvent;
|
2011-03-07 17:11:57 +08:00
|
|
|
class CCSet;
|
2011-04-24 15:38:03 +08:00
|
|
|
class CCTouchDispatcher;
|
|
|
|
|
2011-03-07 17:11:57 +08:00
|
|
|
class CC_DLL CCTouchDelegate
|
2010-07-16 11:39:21 +08:00
|
|
|
{
|
2010-08-27 14:13:32 +08:00
|
|
|
protected:
|
|
|
|
ccTouchDelegateFlag m_eTouchDelegateType;
|
2011-06-20 17:31:38 +08:00
|
|
|
std::map<int, std::string> *m_pEventTypeFuncMap;
|
|
|
|
|
2010-07-16 11:39:21 +08:00
|
|
|
public:
|
2011-04-24 15:38:03 +08:00
|
|
|
friend class CCTouchDispatcher; // only CCTouchDispatcher & children can change m_eTouchDelegateType
|
2010-08-27 14:13:32 +08:00
|
|
|
inline ccTouchDelegateFlag getTouchDelegateType(void) { return m_eTouchDelegateType; }
|
2011-06-20 17:31:38 +08:00
|
|
|
|
|
|
|
CCTouchDelegate() : m_pEventTypeFuncMap(NULL) {}
|
|
|
|
|
|
|
|
virtual ~CCTouchDelegate()
|
|
|
|
{
|
|
|
|
CC_SAFE_DELETE(m_pEventTypeFuncMap);
|
|
|
|
}
|
2011-04-24 15:38:03 +08:00
|
|
|
|
2010-09-29 12:03:21 +08:00
|
|
|
//! call the release() in child(layer or menu)
|
2010-08-27 14:13:32 +08:00
|
|
|
virtual void destroy(void) {}
|
2010-09-29 12:03:21 +08:00
|
|
|
//! call the retain() in child (layer or menu)
|
2010-08-27 14:13:32 +08:00
|
|
|
virtual void keep(void) {}
|
2010-07-16 11:39:21 +08:00
|
|
|
|
2011-06-10 17:51:37 +08:00
|
|
|
virtual bool ccTouchBegan(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent); return false;};
|
2010-07-16 11:39:21 +08:00
|
|
|
// optional
|
2011-04-19 09:32:33 +08:00
|
|
|
|
2011-06-10 17:51:37 +08:00
|
|
|
virtual void ccTouchMoved(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchEnded(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchCancelled(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);}
|
2010-09-03 09:32:13 +08:00
|
|
|
|
|
|
|
// optional
|
2011-06-10 17:51:37 +08:00
|
|
|
virtual void ccTouchesBegan(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchesMoved(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchesEnded(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchesCancelled(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
2011-05-31 14:04:14 +08:00
|
|
|
|
2011-06-20 17:31:38 +08:00
|
|
|
// functions for script call back
|
|
|
|
inline void registerScriptTouchHandler(int eventType, const char* pszScriptFunctionName)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
if (m_pEventTypeFuncMap == NULL)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
m_pEventTypeFuncMap = new std::map<int, std::string>();
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
|
|
|
|
2011-06-20 17:31:38 +08:00
|
|
|
(*m_pEventTypeFuncMap)[eventType] = pszScriptFunctionName;
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
|
|
|
|
2011-06-20 17:31:38 +08:00
|
|
|
inline bool isScriptHandlerExist(int eventType)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
if (m_pEventTypeFuncMap)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
return (*m_pEventTypeFuncMap)[eventType].size() != 0;
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
2011-06-20 17:31:38 +08:00
|
|
|
|
|
|
|
return false;
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
|
|
|
|
2011-06-20 17:31:38 +08:00
|
|
|
inline void excuteScriptTouchHandler(int eventType, CCTouch *pTouch)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
if (m_pEventTypeFuncMap)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
CCScriptEngineManager::sharedScriptEngineManager()->getScriptEngine()->excuteTouchEvent((*m_pEventTypeFuncMap)[eventType].c_str(),
|
|
|
|
pTouch);
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
2011-06-20 17:31:38 +08:00
|
|
|
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
2011-06-20 17:31:38 +08:00
|
|
|
|
|
|
|
inline void excuteScriptTouchesHandler(int eventType, CCSet *pTouches)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
if (m_pEventTypeFuncMap)
|
2011-05-31 14:04:14 +08:00
|
|
|
{
|
2011-06-20 17:31:38 +08:00
|
|
|
CCScriptEngineManager::sharedScriptEngineManager()->getScriptEngine()->excuteTouchesEvent((*m_pEventTypeFuncMap)[eventType].c_str(),
|
|
|
|
pTouches);
|
2011-05-31 14:04:14 +08:00
|
|
|
}
|
|
|
|
}
|
2010-07-16 11:39:21 +08:00
|
|
|
};
|
2011-04-24 15:38:03 +08:00
|
|
|
/**
|
|
|
|
@brief
|
|
|
|
Using this type of delegate results in two benefits:
|
|
|
|
- 1. You don't need to deal with CCSets, the dispatcher does the job of splitting
|
|
|
|
them. You get exactly one UITouch per call.
|
|
|
|
- 2. You can *claim* a UITouch by returning YES in ccTouchBegan. Updates of claimed
|
|
|
|
touches are sent only to the delegate(s) that claimed them. So if you get a move/
|
|
|
|
ended/cancelled update you're sure it's your touch. This frees you from doing a
|
|
|
|
lot of checks when doing multi-touch.
|
|
|
|
|
|
|
|
(The name TargetedTouchDelegate relates to updates "targeting" their specific
|
|
|
|
handler, without bothering the other handlers.)
|
|
|
|
@since v0.8
|
2010-09-29 16:33:52 +08:00
|
|
|
*/
|
2011-03-07 17:11:57 +08:00
|
|
|
class CC_DLL CCTargetedTouchDelegate : public CCTouchDelegate
|
2010-09-03 09:32:13 +08:00
|
|
|
{
|
|
|
|
public:
|
|
|
|
CCTargetedTouchDelegate() { m_eTouchDelegateType = ccTouchDelegateTargetedBit; }
|
2010-09-29 12:03:21 +08:00
|
|
|
/** Return YES to claim the touch.
|
|
|
|
@since v0
|
|
|
|
*/
|
2011-06-10 17:51:37 +08:00
|
|
|
virtual bool ccTouchBegan(CCTouch *pTouch, CCEvent *pEvent) { CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);return false;};
|
2010-09-03 09:32:13 +08:00
|
|
|
|
|
|
|
// optional
|
2011-06-10 17:51:37 +08:00
|
|
|
virtual void ccTouchMoved(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchEnded(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchCancelled(CCTouch *pTouch, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouch); CC_UNUSED_PARAM(pEvent);}
|
2010-09-03 09:32:13 +08:00
|
|
|
};
|
2011-04-24 15:38:03 +08:00
|
|
|
|
2010-09-29 16:33:52 +08:00
|
|
|
/** @brief
|
|
|
|
This type of delegate is the same one used by CocoaTouch. You will receive all the events (Began,Moved,Ended,Cancelled).
|
|
|
|
@since v0.8
|
|
|
|
*/
|
2011-03-07 17:11:57 +08:00
|
|
|
class CC_DLL CCStandardTouchDelegate : public CCTouchDelegate
|
2010-09-03 09:32:13 +08:00
|
|
|
{
|
|
|
|
public:
|
2011-01-10 17:54:44 +08:00
|
|
|
CCStandardTouchDelegate() { m_eTouchDelegateType = ccTouchDelegateStandardBit; }
|
2010-09-03 09:32:13 +08:00
|
|
|
// optional
|
2011-06-10 17:51:37 +08:00
|
|
|
virtual void ccTouchesBegan(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchesMoved(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchesEnded(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
|
|
|
virtual void ccTouchesCancelled(CCSet *pTouches, CCEvent *pEvent) {CC_UNUSED_PARAM(pTouches); CC_UNUSED_PARAM(pEvent);}
|
2010-09-03 09:32:13 +08:00
|
|
|
};
|
2010-07-16 11:39:21 +08:00
|
|
|
|
2010-08-04 15:46:12 +08:00
|
|
|
}//namespace cocos2d
|
2010-07-16 11:39:21 +08:00
|
|
|
|
|
|
|
#endif // __TOUCH_DISPATHCHER_CCTOUCH_DELEGATE_PROTOCOL_H__
|