cocos2dx 常用函数和宏定义

短命女 2022-08-25 13:58 202阅读 0赞

最近我们的cocos2d-x游戏项目已经进入了正式开发的阶段了，几个dev都辛苦码 代码。cocos2d-x还是一套比较方便的api的，什么action啊、director啊、ccpoint啊都蛮便捷的。但是我看到几个dev有时 候会很不知道用它们，还是首先自己去写函数……

用一些比较原始、低效率的方法……

甚至是copy / paste……

这不科学啊！你不能这么勤劳啊！你这么勤劳要出事的啊！每年有多少程序员过劳死啊！程序员一定要是懒骨头才是正道啊！

首先第一个，看到有问题，要写很多代码处理问题，自己动手，丰衣足食——不是一 条好路，是一条革命的老路。我们前面有那么多前任程序员的尸体，要学会翻烂它们……然后本文也是菜笔写的，仅简整理一下自己用的比较多一些 cocos2d-x的util，帮助大家提高效率，要变懒，会偷懒，没有最懒，只有更懒。

**1.数学类**

cocos2d-x 里使用最多的数学类型是CCPoint，一个点，本质上也是一个向量，对于向量和向量之间有很多的数学操作要做，oh我知道要干什么，也许我知道怎么求一个值但是不知道怎么求得高效（或者不知道），怎么办我能偷懒吗？那当然可以。这其实并不是一个懒的标准，因为有一些方法写多了也可能确实稍微有那么点麻烦，所以自然cocos2d提供了一套ccp系列来帮助我们完成很多的工作，也显示一下库程序员照顾开发程序员的懒惰精神（当然他们自己也用，他们也很懒）。

那我们首先创建向量

ccp(x, y); // 以坐标x，y创建一个向量这个大家都知道。 ccpFromSize(s); // 以size s的width为x，height为y创建一个向量

有了ccp很多人就觉得自己已经够懒了，因为C++是可以用CCPoint()创建临时变量的，就是喜欢少打几个字吧。写个ccp(v1.x + v2.x, v1.y + v2.y)也不长……但是，有没有稍微再懒一点的？

——这个可以有。

基本的加法、减法、取负、数乘

![复制代码][copycode.gif]

ccpAdd(v1, v2); // 等价 ccp(v1.x+v2.x, v1.y+v2.y); ccpSub(v1, v2); // 等价 ccp(v1.x-v2.x, v1.y-v2.y); ccpNeg(v) // 等价 ccp(-v.x, -v.y);
    
    ccpMult(v, s); //等价 ccp(v.x * s, v.y * s); s是个浮点数嘛

![复制代码][copycode.gif]

不错，但是这个写法不是那么符合我们原生C++程序员的习惯，向量运算符呢？可惜cocos2d原本是一套objc的API，没有操作符重载，cocos2d-x也没有像一些原生的C++数学库一样直接重载向量运算符。不过重载一下还是很方便的，我们的项目里声明了一个数学头文件，也就几行代码就好了：

![复制代码][copycode.gif]

inline cocos2d::CCPoint operator + (const cocos2d::CCPoint& v1, const cocos2d::CCPoint v2) {
         return ccp(v1.x + v2.x, v1.y + v2.y); } inline cocos2d::CCPoint operator - (constcocos2d::CCPoint& v1, const cocos2d::CCPoint v2) { return ccp(v1.x - v2.x, v1.y - v2.y); } inlinecocos2d::CCPoint operator - (const cocos2d::CCPoint& v) { return ccp(-v.x, -v.y); } inlinecocos2d::CCPoint operator * (const cocos2d::CCPoint& v1, float scale) { return ccp(v1.x * scale, v1.y * scale); } inline cocos2d::CCPoint operator * (float scale, const cocos2d::CCPoint& v1) {
         return ccp(v1.x * scale, v1.y * scale); } inline cocos2d::CCPoint operator / (constcocos2d::CCPoint& v1, float scale) { return ccp(v1.x / scale, v1.y / scale); } inline booloperator == (const cocos2d::CCPoint& v1, const cocos2d::CCPoint& v2) { return (v1.x == v2.x) && (v1.y == v2.y); } inline bool operator != (const cocos2d::CCPoint& v1, const cocos2d::CCPoint& v2) { return (v1.x != v2.x) || (v1.y != v2.y); }

![复制代码][copycode.gif]

顺便还重载了等号和不等号，这样就可以直接用+、-来进行向量加减法，\*、 / 进行数乘，==、!=判断是否相等了。程序员，这样才够懒！

什么，你说还有 +=、 -=、 /=、 \*= 没重载？哦，改那些必须得修改到cocos2d-x的源代码了，改完还得重新编译一遍，略微有点懒得改吧，至少CCPoint还是能用 = 赋值的。我们还是看看cocos2d-x还提供了什么数学方法吧。

取中点！本来也就一 ccpMult(ccpAdd(v1,v2), 0.5f) 的事，开发者说不要，我就是要少打几个字，好吧库程序员就给了一个方法

ccpMidpoint(v1, v2); // 等价 ccp( (v1.x + v2.x)/2, (v1.y + v2.y)/2 );

点乘、叉乘、投影

ccpDot(v1, v2); // 等价 v1.x * v2.x + v1.y * v2.y; ccpCross(v1, v2); // 等价 v1.x * v2.y - v1.y * v2.x;
    
    ccpProject(v1, v2) // 返回的是向量v1在向量v2上的投影向量

喜闻乐见求长度、距离和各自的平方值（在仅需要比较两个长度大小时使用长度平方，因为省去了开方这一步，效率要高不少，这就不光是程序员的懒了，懒得要有效率）

![复制代码][copycode.gif]

ccpLength(v) // 返回向量v的长度，即点v到原点的距离 ccpLengthSQ(v) // 返回向量v的长度的平方，即点v到原点的距离的平方 ccpDistance(v1, v2) // 返回点v1到点v2的距离 ccpDistanceSQ(v1, v2) // 返回点v1到点v2的距离的平方
    
    ccpNormalize(v) // 返回v的标准化向量，就是长度为1

![复制代码][copycode.gif]

旋转、逆时针90度、顺时针90度（90度的效率当然是更快的。。。同样懒得有效率）

![复制代码][copycode.gif]

ccpRotate(v1, v2); // 向量v1旋转过向量v2的角度并且乘上向量v2的长度。当v2是一个长度为1的标准向量时就是正常的旋转了，可以配套地用ccpForAngle ccpPerp(v); // 等价于 ccp(-v.y, v.x); （因为opengl坐标系是左下角为原点，所以向量v是逆时针旋转90度） ccpRPerp(v); // 等价于 ccp(v.y, -v.x); 顺时针旋转90度

![复制代码][copycode.gif]

上面说到ccpRotate，配套的有向量和弧度的转换向量，还有一些角度相关的

![复制代码][copycode.gif]

ccpForAngle(a); // 返回一个角度为弧度a的标准向量 ccpToAngle(v); // 返回向量v的弧度 
    
    ccpAngle(a, b); // 返回a，b向量指示角度的差的弧度值
    
    ccpRotateByAngle(v, pivot, angle) // 返回向量v以pivot为旋转轴点，按逆时针方向旋转angle弧度

![复制代码][copycode.gif]

线段相交的检测，哦天哪原来库程序员把这些事情都干了！我还在傻傻地想线段相交算法！实在是太勤奋了！

![复制代码][copycode.gif]

ccpLineIntersect(p1, p2, p3, p4, &s, &t); // 返回p1为起点p2为终点线段1所在直线和p3为起点p4为终点线段2所在的直线是否相交，如果相交，参数s和t将返回交点在线段1、线段2上的比例 // 得到s和t可以通过 p1 + s * (p2 - p1) 或 p3 + t * (p4 - p3) 求得交点。 ccpSegmentIntersect(A, B C, D) // 返回线段A-B和线段C-D是否相交 ccpIntersectPoint(A, B, C, D) // 返回线段A-B和线段C-D的交点

![复制代码][copycode.gif]

数学方法没有列全，更多请直接查头文件CCPointExtension.h。基本该有的都有了。

当然数学不只有向量，还有一些其他的……这些也很经常用到。小懒一下。

CC_RADIANS_TO_DEGREES(a); // 弧度转角度 CC_DEGREES_TO_RADIANS(a); // 角度转弧度 CCRANDOM_0_1(); //产生0到1之间的随机浮点数 CCRANDOM_MINUS1_1(); // 产生-1到1之间的随机浮点数

**2.语句宏**

常用的，首先第一个，断言。

CCAssert(cond, msg); // 断言表达式cond为真，如果不为真，则显示字符串msg信息

在这之后，也非常常用的，有遍历CCARRAY、CCDICTIONARY的宏。

![复制代码][copycode.gif]

CCArray* _array; CCObject* _object; // 用来遍历数组的临时变量 CCARRAY_FOREACH(_array, _object) //正向遍历 { // todo with _object.... } CCARRAY_FOREACH_REVERSE(_array, _object) // 反向遍历 { //todo with _object.... } CCDictionary* _dict; CCDictElement* _elmt; // 遍历表的临时变量CCDICT_FOREACH(_dict, _elmt) { 　　// todo with elmt; }

![复制代码][copycode.gif]

CCArray和CCDictionary都没有实现模版，取得的遍历元素之后还需要强制转换，假如说，嗯，通常数组里的元素都是同一类型的，比如这样

![复制代码][copycode.gif]

CCArray* _array; CCObject* _object; // 用来遍历数组的临时变量 CCARRAY_FOREACH(_array, _object) //正向遍历 { CCSprite* _bullet = (CCSprite*)_object; // todo with _bullet.... }

![复制代码][copycode.gif]

总觉得我好像多定义了一个CCObject\* \_object，因为它没什么用似的？而且我也懒得多写一句强制转换，可以吗？首先看看CCARRAY\_FOREACH怎么定义的

![复制代码][copycode.gif]

#define CCARRAY_FOREACH(__array__, __object__) \ if ((__array__) && (__array__)->data->num > 0) \for(CCObject** arr = (__array__)->data->arr, **end = (__array__)->data->arr + (__array__)->data->num-1; \ arr <= end && (((__object__) = *arr) != NULL); \ arr++)

![复制代码][copycode.gif]

看到那句 (\_\_object\_\_) = \*arr 了吗？好，要直接强制转换，就提供一个类型，在这里开刀！

![复制代码][copycode.gif]

#define CCARRAY_TFOREACH(__array__, __object__, __type__) \ if ((__array__) && (__array__)->data->num > 0) \ for(CCObject** arr = (__array__)->data->arr, **end = (__array__)->data->arr + (__array__)->data->num-1; \ arr <= end && (((__object__) = (__type__)*arr) != NULL); \ arr++)

![复制代码][copycode.gif]

然后用这个CCARRAY\_TFOREACH宏，这样我们的遍历就可以做得更懒一点

![复制代码][copycode.gif]

CCArray* _array; CCSprite* _bullet; // 用来遍历数组的临时变量 CCARRAY_TFOREACH(_array, _bullet, CCSprite*) // 正向遍历 { // todo with _bullet.... }

![复制代码][copycode.gif]

舒坦，偷懒改造，完。

在定义类型的时候，经常需要定义一些getter setter，有cocos2d从objc带来的CC\_PROPERTY 和 CC\_SYNTHESIZE。

![复制代码][copycode.gif]

class Ship: public cocos2d::CCNode { // 定义一个int类的属性m_energy变量，该变量访问权限是protected。 //后面的方法名Energy，即声明了一个int getEnergy() 和一个 void setEnergy(int value)的方法，具体实现需要自己在cpp中定义 CC_PROPERTY(int, m_energy, Energy); // 基本与上相同，但是get方法传引用，即声明了一个 int& getEnergy(); CC_PROPERTY_PASS_BY_REF(int, m_energy, Energy); // 同样定义变量，但是只发声明 get 方法，具体实现需要自己在cpp中定义 CC_PROPERTY_READONLY(int, m_energy, Energy); CC_PROPERTY_READONLY_PASS_BY_REF(int, m_energy, Energy); // 同样定义变量，并且直接定义默认的get/set方法。相似的也有前4类 CC_SYNTHESIZE(cocos2d::CCObject*, m_weapon, Weapon);CC_SYNTHESIZE_PASS_BY_REF(cocos2d::CCObject*, m_weapon, Weapon);CC_SYNTHESIZE_READONLY(cocos2d::CCObject*, m_weapon, Weapon);CC_SYNTHESIZE_READONLY_PASS_BY_REF(cocos2d::CCObject*, m_weapon, Weapon); // 在setWeapon的时候，调用原有m_weapon的release，并且调用新值的的retain。当然已经排除了意外情况（相等或者NULL之类的）。CC_SYNTHESIZE_RETAIN(cocos2d::CCObject*, m_weapon, Weapon); };

![复制代码][copycode.gif]

需要注意的是

1.CC\_PROPERTY更适用于快速声明一个值属性，而CC\_SYNTHESIZE更适用于声明一个对象。因为CC\_SYNTHESIZE提供的默认set没有任何合法性检查对于值属性来说太不实用。

2.这些方法的声明全部都是virtual的，即便是内联，声明为virtual的方法也不会产生内联函数，所以不管是CC\_PROPERTY还是CC\_SYNTHESIZE，他们的效率都是不高的。

3.CC\_PROPERTY的get方法都没有对函数体声明const修饰符，这意味着对const对象，并不能调用CC\_PROPERTY声明的get方法（我怎么觉得这是个cocos2d-x的BUG……）。

4.在CC\_SYNTHESIZE方法之后直接声明函数或者变量都会变成public:……注意，嗯。

不好用？跳过去看下定义，自己去定义一个呗……懒得看那就算了。

然后还有快捷的CREATE\_FUNC，自动生成一个默认的静态create方法。这实在方便了

![复制代码][copycode.gif]

class Class: public cocos2d::CCNode {
    public: CREATE_FUNC(Class); // 自动生成一个不带参数的 create 静态方法，返回一个Class*类型指针。自动调用了init和autorelease方法 } //CREATE_FUNC(Class) 等价于与以下 static Class* create() { Class* pRet = new Class(); if (pRet && pRet->init()) { pRet->autorelease(); return pRet; } else { delete pRet; pRet = NULL; return NULL; } }

![复制代码][copycode.gif]

而且这也是建议的C++构造函数和init方法的使用规范，先分配空间之后立刻初始化，并且由初始化结果确定能否返回一个可用的对象。在定义特定参数的create方法时也应当这样。

说到初始化，就不得不说到析构，还有一些析构相关的宏。我要release一堆对象，挨个都得判断对象是不是NULL？还要把release后的东西赋值NULL？程序员懒得写这么多行代码……

![复制代码][copycode.gif]

//所谓的safe逻辑都是这样的，先检查指针p是否为NULL，不为NULL，则执行delete p或者p->release等等。CC_SAFE_DELETE(p); // 当p不为NULL，delete p 并且将 p 赋为 NULL CC_SAFE_DELETE_ARRAY(p); //...delete[] p.. CC_SAFE_FREE(p); // ...free p ... CC_SAFE_RELEASE(p); // 当p不为NULL，p->release()CC_SAFE_RELEASE_NULL(p); // 当p不为NULL，p->release() 并且将 p 赋为 NULL CC_SAFE_RETAIN(p); // 当p不为NULL，p->retain()

![复制代码][copycode.gif]

顺便还有交换两个变量的时候，可以都喜欢懒，写个 void swap(int& a, int &b)什么的、再写void swap(float& a, float& b)什么的，再写个 void swap(string& a, string& b)什么的……总感觉你懒都没人家库程序员懒的懒……这里有个CC\_SWAP的宏……

![复制代码][copycode.gif]

CC_SWAP(x, y, type); // 等价于于以下 { type temp = (x); x = y; y = temp; } // 至少x 和 y 不是表达式的时候这个宏都能工作正常，也不用担心temp变量重复

![复制代码][copycode.gif]

什么？你说你不服？你说你连type都不想声明……？你居然这么懒那你怎么办你怎么能做到这么懒的啊！你说你用模版？

template <<span style="color: #0000ff;">typename t> inline void swap<<span style="color: #0000ff;">typename t>(t& a, t& b);

好吧你赢了……

还有cocos2d库开发人员很喜欢用的CC\_BREAK\_IF，这个宏有什么特别的含义吗？难道其实不就是一行的 if(???) break; ？嗯，就是……没区别。但是你不觉得CC\_BREAK\_IF( ??? );懒地比人家高端吗？现在的IDE都能自动tab出宏耶！还有可以用下面的while(0)循环写还能代替一些if(???) return false;耶！

![复制代码][copycode.gif]

bool Class::init() { bool bRet = false; do { // do some initialization 1 CC_BREAK_IF(cond); // 当表达式cond为真时候跳出。 // do some more initialization bRet = true; } while(0); return bRet; }

![复制代码][copycode.gif]

……积小懒，成大懒啊！可见有一些人，是真的真的很懒很懒……

还能更懒一点吗？答案是肯定的。每当写一个.h时，cocos2d的库程序员都要写一个 namespace cocos2d \{...\} 吧；每当写一个cpp的时候，你也总是要用到using namespace吧？。。他们都懒得多打这几个字母。。

NS_CC_BEGIN // 这是 namespace cocos2d {
          NS_CC_END // 这是 } ！！！！ USING_NS_CC; // 这是 using namespace cocos2d; 这可以是常用宏。

[copycode.gif]: /images/20220824/0e44c61f864f47f48b2af7f9d5fba326.png