【cocos2d-x 3.x 学习笔记】 HelloWorld —— 小程序大道理

cocos2d-x 3.2 的环境搭建可以参考官方给出的教程。这里我使用的是 Win7 + VS2013

1. 创建项目

在Windows下搭建好环境后，打开命令行（按 Win+R，输入cmd），执行下面命令：

cocos new MyGame -l cpp -d   F:\ -p mypackage.com

执行上述命令后，将会在F盘根目录下创建名为“MyGame”的cocos2d工程，使用的语言是C++。该命令的详细用法可以使用 cocos new --help 查看。下面是生成MyGame目录内容：

2. 编译运行HelloWorld示例程序

打开   F:\MyGame\proj.win32\MyGame.sln 文件，VS启动，将MyGame设为启动项（在MyGame项目的右键菜单中设置），按F5（或点击工具栏中的 按钮）运行，显示如下程序界面说明运行成功。

3. 浏览源代码

     VS解决方案的目录结构应该是这样子的。

 

程序都有一个入口点，在C++就是main函数了，打开main.cpp，代码如下：

#include "main.h"
#include "AppDelegate.h"
#include "cocos2d.h"

USING_NS_CC;

int APIENTRY _tWinMain(HINSTANCE hInstance,
                       HINSTANCE hPrevInstance,
                       LPTSTR    lpCmdLine,
                       int       nCmdShow)
{
    UNREFERENCED_PARAMETER(hPrevInstance);
    UNREFERENCED_PARAMETER(lpCmdLine);

    // create the application instance
    AppDelegate app;
    return Application::getInstance()->run();
}

USING_NS_CC 是一个宏定义，等价于 using namespace cocos2d。

UNREFERENCED_PARAMETER(hPrevInstance); 和
UNREFERENCED_PARAMETER(lpCmdLine); 也是宏定义，展开有就是传入的参数本身。这里仅仅只是让编译器不会出现诸如“未使用的变量XX”的警告。

接下来两行代码是重点

AppDelegate app; 定义了一个AppDelegate 的实例

Application::getInstance()->run(); 先获取Application类的一个实例，然后调用该实例的run()方法。

跳转到Application::getInstance()成员函数的定义，其是一个静态成员函数，函数直接返回了成员变量sm_pSharedApplication，并且在返回前判断其是否为空。

Application* Application::getInstance()
{
    CC_ASSERT(sm_pSharedApplication);
    return sm_pSharedApplication;
}

Application::getInstance()如果调用成功，说明其成员变量sm_pSharedApplication不为空，那它是在哪里被赋值的呢？首先想到的是构造函数，如下：

Application::Application()
: _instance(nullptr)
, _accelTable(nullptr)
{
    _instance    = GetModuleHandle(nullptr);
    _animationInterval.QuadPart = 0;
    CC_ASSERT(! sm_pSharedApplication);
    sm_pSharedApplication = this;
}

果然，在Application类的构造函数中，它将自身的地址保存在了静态成员变量sm_pSharedApplication中，由于sm_pSharedApplication是静态成员变量，所以多个类的实例共享同一个成员变量。下问题又来了，Application类是什么时候执行的构造函数的呢？也没看见创建Application的实例啊！问题的答案就藏在下面这行代码中：

AppDelegate app;

查看AppDelegate类的声明，发现其继承自Application类，派生类在创建时会先调用基类的构造函数完成基类的初始化，所以执行上诉代码时调用了Application类的构造函数，从而初始化了sm_pSharedApplication（将AppDelegate地址保存在sm_pSharedApplicationo中），这样调用Application::getInstance()时，返回的是指向AppDelegate的基类的指针。

Application::getInstance()->run()实际就是调用AppDelegate的基类Application的成员函数run()，下面是该函数的实现，重点注意其中的 applicationDidFinishLaunching()函数，在run()函数内部调用了AppDelegate:: applicationDidFinishLaunching()成员函数。

int Application::run()
{
...
    // Initialize instance and cocos2d.
    if (!applicationDidFinishLaunching())
    {
        return 0;
    }

...
    return true;
}

进一步看看 AppDelegate:: applicationDidFinishLaunching()成员函数的实现，发现在其内部调用了HelloWorld::CreateScene()，这样我们在HelloWorld类中写的代码才得以被执行。

bool AppDelegate::applicationDidFinishLaunching() {
    // initialize director
    auto director = Director::getInstance();
    auto glview = director->getOpenGLView();
    if(!glview) {
        glview = GLView::create("My Game");
        director->setOpenGLView(glview);
    }

    // turn on display FPS
    director->setDisplayStats(true);

    // set FPS. the default value is 1.0/60 if you don't call this
    director->setAnimationInterval(1.0 / 60);

    // create a scene. it's an autorelease object
    auto scene = HelloWorld::createScene();

    // run
    director->runWithScene(scene);

    return true;
}

4. HelloWorld 分析

     先看看HelloWorld类的声明，它继承自cocos2d命名空间下的Layer类。上一节说到，HelloWorld::createScene()会被调用，所以从该成员函数开始分析其调用过程。

class HelloWorld : public cocos2d::Layer
{
public:
    // there's no 'id' in cpp, so we recommend returning the class instance pointer
    static cocos2d::Scene* createScene();

    // Here's a difference. Method 'init' in cocos2d-x returns bool, instead of returning 'id' in cocos2d-iphone
    virtual bool init();  
    
    // a selector callback
    void menuCloseCallback(cocos2d::Ref* pSender);
    
    // implement the "static create()" method manually
    CREATE_FUNC(HelloWorld);
};

HelloWorld::createScene()成员函数内部逻辑很简单，创建场景->创建层->将层添加到场景中->返回场景。

Scene* HelloWorld::createScene()
{
    // 'scene' is an autorelease object
    auto scene = Scene::create();
    
    // 'layer' is an autorelease object
    auto layer = HelloWorld::create();

    // add layer as a child to scene
    scene->addChild(layer);

    // return the scene
    return scene;
}

但是有一点，HelloWorld::create()函数从何而来？要么是继承自基类cocos2d::Layer::create()，要么是HelloWorld自己定义的。先到HelloWorld的基类cocos2d::Layer::create()中看看，代码如下，创建了一个Layer类的示例，然后调用了其虚函数init()，在init()函数中只是简单的设置了层的大小。

Layer *Layer::create()
{
    Layer *ret = new Layer();
    if (ret && ret->init())
    {
        ret->autorelease();
        return ret;
    }
    else
    {
        CC_SAFE_DELETE(ret);
        return nullptr;
    }
}
bool Layer::init()
{
    Director * director = Director::getInstance();
    setContentSize(director->getWinSize());
    return true;
}

如果说HelloWorld::create()函数继承自基类Layer，那么应该看到的是一个黑乎乎的界面，而实际我们看到了一个有图片和文字的界面，所以HelloWorld::create()不是继承自基类Layer，而是自己定义的，在哪里定义的？就在下面这行代码中：

CREATE_FUNC(HelloWorld);

CREATE_FUNC是一个宏定义：

#define CREATE_FUNC(__TYPE__) \
static __TYPE__* create() \
{ \
    __TYPE__ *pRet = new __TYPE__(); \
    if (pRet && pRet->init()) \
    { \
        pRet->autorelease(); \
        return pRet; \
    } \
    else \
    { \
        delete pRet; \
        pRet = NULL; \
        return NULL; \
    } \
}

CREATE_FUNC(HelloWorld)展开后如下，创建HelloWorld类的示例，并调用HelloWorld::init()函数，关于层的操作就在init()函数中。

static HelloWorld *create() 
{ 
    HelloWorld *pRet = new HelloWorld();
    if (pRet && pRet->init()) 
    { 
        pRet->autorelease(); 
        return pRet; 
    } 
    else 
    { 
        delete pRet; 
        pRet = NULL; 
        return NULL; 
    } 
}

上面的分析可能看着有点乱了，不要紧我画了一张草图帮助理清思路，将几个关键的函数圈出来了。

5. 总结

     建立一个新的cocos2d-x项目，然后编译运行，然后从main函数开始分析其执行的过程，最后又分析了一下HelloWorld类是如何被调用的。希望本文能帮助你理清一点点思绪，我也是刚接触cocos2d-x，借着笔记整理下自己的所思所想，如有不正确的地方，还请指出，相互交流，进步更快，希望cocos2d能发展的越来越好。