Cocos2d-x 3.8.1+Cocos Studio 2.3.2捉虫记之控制场景文件中的骨骼动画

引子

这段时间一直努力在把早期版本的拇指接龙游戏(Cocos2d-x 2.2.3+CocoStudio 1.4.0.1)升级到当前相对稳定的高大上环境——Cocos2d-x 3.8.1+Cocos Studio 2.3.2。行程中遇到不少麻烦,时间不知不觉像流水一样悄然逝去(这正是我时不时酸酸地想起“程序猿”三字的主要原因)。想之再三,还是努力记录下来,一来为自己可能逝去的记忆,二来为一些新伙伴少踏几个坑而节约些许时间。

本文讨论的是在新版本中如何从代码中控制在cocos Studio场景编辑器中加入的骨骼动画的操作。

cpp-tests中的误导

在升级之前就从网络上及部分手头图书中了解到cocos2d-x 3.x版本中的较大变动。于是,还是很小心地决定先从研读新版本发行中相伴随的最经典的示例工程cpp-tests开始。在有了一个整体思路后,结合原来版本代码开始更新,有的是代码部分,有的是studio图形数据部分,当然也包括该示例游戏涉及的有米积分墙SDK相关代码的更新与ShareSDK集成部分的更新。

网络搜索及研究示例工程cpp-tests的结果表明,官方的文档有不少已经过时。但是,值得肯定的一点是工程cpp-tests中提倡尽量使用当前最新的cocos2d-x代码操纵早期几乎是各种版本studio导出的资源文件,还包括Flash动画文件及Spine动画文件,等等。

但遗憾的是,相应的官方资料中并没有指出这一点。当然,在示例工程注释中也没有必要过于琐碎地添加这种使用说明信息。

于是,对于像我这样的新版本的发烧友来说,要使用其提供的最新技术主要有两个途径:一个是尽量全面地查看官方文档(但是最新版本有关资料少得可怜),再一个就是阅读SDK源码。

如题中所示的“误导”部分地体现在当前最新的cocos2d-x c++代码操纵studio导出的动画资源文件方面。

如果选择开发语言是c++,那么对应的studio版本(2.3.2)的资料文件只能是.csb文件(场景文件、图层文件、结点文件、骨骼动画文件、3D场景文件的扩展名都是.csb)。

个别网络资料上说是可以操纵studio版本(2.3.2)导出的json文件(如果选择语言是javascript的话),我在尝试后发现基本不可以,但不是完全不可以。源码分析发现,这种方式导出的json文件与早期studio版本导出的exportjson文件或者json文件格式上存在很多的不一致。

因此,应该明确的一点就是对于使用cocos2d-x 3.8.1 C++代码操作的studio版本(2.3.2)导出的资源文件的扩展名应当是.csb文件(二进制文件)。

但是,工程cpp-tests中的确存在大量的操作早期版本场景文件、GUI图层文件、骨骼动画文件的大量示例代码,而官方文档及这些文件注释中又缺少必要的说明,因此很容易误导初学者,而致使其浪费大量的时间进行可行性编码试验。

对于新版本环境下骨骼动画的操作我还没有全面试验,因此仅作部分试验结果说明。

来自www.cocoachina.com的启示

在上述网站的《Cocos骨骼动画功能解密》(http://www.cocoachina.com/cocos/20150907/13355.html)一文中我捕获到如下最新的参考代码。

//首先通过CSLoader读入Cocos编辑器导出的csb文件,并将CSLoader返回的Node转换为SkeletonNode*类型
SkeletonNode* skeletonNode = static_cast(CSLoader::createNode("DemoPlayer.csb"));
//获得到骨骼节点之后,可以对骨骼节点的Scale、Position等进行设置
skeletonNode->setScale(0.2f);
skeletonNode->setPosition(150, 150);
//然后将骨骼节点添加到父节点上
this->addChild(skeletonNode);
//接下来,再次通过CSLoader读入Cocos编辑器导出的csb文件,创建一个ActionTimeline对象,这个对象存储着骨骼节点的所有动画
ActionTimeline* action = CSLoader::createTimeline("DemoPlayer.csb");
//我们为骨骼节点的动画设置一个tag值方便后边取出动画,建议这里使用枚举的形式来定义tag值(为了方便这里直接写100了)
action->setTag(100);
skeletonNode->runAction(action);
//播放action中的动画(参数1:动画名称   参数2:是否循环播放)
action->play("animation0", false);
//我们可以通过每个骨骼节点上边的某个皮肤(图片)的名字来获取这"块"骨骼
const std::string weapBoneName = "Layer20";
auto weaponHandeBone = skeletonNode->getBoneNode(weapBoneName);
//我们可以创建一个Sprite并把它加到刚刚获取到的那"块"骨骼的皮肤中
auto weapSkinToAdd = Sprite::create("ArcherPeng/girl_arms.png");
weapSkinToAdd->setName("Knife");
weapSkinToAdd->setPosition(Vec2(135, 23));
weapSkinToAdd->setScale(3.0f);
weapSkinToAdd->setRotation(86);
weaponHandeBone->addSkin(weapSkinToAdd, false);//加载到皮肤中
//然后将新加入的皮肤显示出来
weaponHandeBone->displaySkin(weapSkinToAdd, true);
//当然也可以换回原来的("3"指的是"3.png"原先皮肤的名字)
weaponHandeBone->displaySkin("3", true);
Node *node=CSLoader::createNode("DemoPlayer.csb");

3.8.1 c++代码加载studio 2.3.2导出的各种.csb二进制资源文件的统一方式。但是,根据本人浮浅分析:更细致的资料数据操纵示例工程中根本没有提供。

 

初见天日

下面以我自己创建的一个简单示例来说明如何从C++ 3.8.1代码中操作studio 2.3.2导出的.csb文件。

首先,看一下我的示例工程截图(我创建了一个场景文件MainScene.csd,其中加入的是一个骨骼动画文件):

wKiom1ZJ0vfD_NNMAAIpvEfmcKM036.jpg

骨骼动画文件是DemoPlayer.csd,如下,你一看就知道的。

wKiom1ZJ0siCu-jTAANS6uEhgzs191.jpg

接下来,问题的关键定位在:如何从cocos2d-x 3.8.1 c++代码中操作上面导出的二进制资源MainScene.csb,并进而播放其中的骨骼动画以及进行其他更细致的骨骼动画行为控制。

在分析了上面代码提示和综合cpp-tests工程代码后,我作出如下大胆尝试:

        Node * rootNode = CSLoader::createNode("MainScene.csb");
         Node* child = rootNode->getChildByName("ProjectNode_1");
 
         SkeletonNode* arm = static_cast<SkeletonNode*>(child);
         addChild(arm);
 
         ActionTimeline* action = CSLoader::createTimeline("MainScene.csb");
         arm->runAction(action);
         action->gotoFrameAndPlay(0);

部分缺憾

cpp-tests中经常有如下代码:

       Node* _rootNode = SceneReader::getInstance()->createNodeWithSceneFile("res/MainScene.json");

恰巧,我的机器上有一个老版本的cocoStudio 1.4.0.1,其导出的场景文件正是json格式。试验证明,使用cocos2d-x c++ 3.8.1通过上述代码操作场景文件非常顺利。当然,接下来,相应的进一步操作场景中对象的代码也是没有问题的,与示例工程中一致。

但是,简单地源码跟踪发现,createNodeWithSceneFile文件也可以使用.csb文件作为参数。尽管没有细致研究,但是试验证明下面的代码根本是行不通的。

         Node* _rootNode = SceneReader::getInstance()->createNodeWithSceneFile("res/MainScene.csb");
         Node* child = _rootNode->getChildByName("ProjectNode_1");

类似于上面的问题,示例工程中还存在不少,希望研究的同学们小心注意了。

 

 

【补充】

在示例文件SceneEditorTest.cpp 中的确存在使用上述方法,即createNodeWithSceneFile加载.csb文件的情形。例如下面所示的函数:

wKioL1ZJ4TOBKaTlAAH9rxeeokw291.jpg

 

注意,其中相关帮助函数loadFileChangeHelper代码如下所示:

void SceneEditorTestBase::loadFileChangeHelper(std::string& filePathName)

{

    std::string::size_type n = filePathName.find_last_of(".");

 if(n == std::string::npos)

  return;

 filePathName = filePathName.substr(0,n);

 if(_isCsbLoad)

  filePathName.append(".csb");

 else

  filePathName.append(".json");

}

而上面的示例,即cpp-tests中的一部分在我的机器上是顺利调试通过的。也就是说,createNodeWithSceneFile的确能够加载.csb文件,但却不是cocos studio 2.3.2导出的.csb文件。据我的估计,应该是早期版本studio导出的.csb文件。

 

怎么样?感觉有些麻烦吧。不同的.csb文件居然有的能够通过createNodeWithSceneFile加载,而有的不行!遗憾的是,官方没有给出明确说明!!!

 

 

 

 

小小结

不敢多说一些,因为我到此的结论只停留在片面。但是,有一点基本是肯定的:当前的CPP-TESTS中对于早期STUDIO资源操作提供的示例已经非常丰富了,但相比之下,对于对应最新版本的STUDIO导出的二进制.csb文件的深入操作示例提供的非常欠缺。因此,这种情况下,要想使用最新版本的studio及相应版本的cocos2d-x 3.x版本,深入研究SDK源码是必需的;但同时也要结合网络上尽可能新的示例(特别是来自于cocoachina.com网络的资源)进行。