cocos2d-x で関数ポインターを使ってレイヤー間の連携をする

はじめに

• cocos2d-x でゲームを作るときに、タイマーの表示やスコアの表示など、きまりきった機能を別レイヤーにまとめて整理したいと考えました。
• そこで、タイマー切れの処理やスコア更新処理など、レイヤーとレイヤーの間で連携をとるために、schedule_selector などで扱っているコールバックの仕組みについて調べてみました。

新しいプロジェクトの作成

• create_project.py で新しいプロジェクト MyGame を作成してテストします。

呼び出されるレイヤーの作成

• メインのレイヤーを HelloWorldScene として、呼び出される側のレイヤーとして MyLayer を作ります。
• MyLayer.h として作成します。

#ifndef MyGame_MyLayer_h
#define MyGame_MyLayer_h

#include "cocos2d.h"

USING_NS_CC;

class MyLayer : public CCLayer
{
public:
    virtual bool init()
    {
        if (!CCLayer::init()) {
            return false;
        }
        return true;
    }
    CREATE_FUNC(MyLayer);
};

#endif

コールバック呼び出し用の型とマクロの宣言

• CCObject.hを参照すると、コールバックの仕組みは関数ポインターというもので実装しているようです。
• 関数ポインターとはそのまま関数のポインターで、関数の参照を値として扱えるようになることで、動的な関数呼び出しができるようになるそうです。
• cocos2d-x のバージョン3だと無名関数まで使えるようになるそうですが、アルファなので怖いので指をくわえてスルーします。
• MyLayer.h に追記します。

/**
 * 関数ポインターの型名の宣言
 *   CCObject のメソッドであり、
 *   void 型を返し、
 *   CCObject* を引数として受け取る関数ポインターを、
 *   SEL_MySelector という型名で扱う
 */
typedef void (CCObject::* SEL_MySelector)(CCObject*);

/**
 * 関数ポインターを取得するマクロの宣言
 *   my_selector("関数名") と記述した場合に、
 *   指定した関数のポインターを SEL_MySelector 型のポインターとして扱う
 */
#define my_selector(_SELECTOR) (SEL_MySelector)(&_SELECTOR)

コールバック関数を受け取るメソッドの作成

• MyLayer 側で、コールバック関数を呼び出す関数を作成します。

    void doCallback(CCObject* caller, SEL_MySelector selector)
    {
        CCLOG("[doCallback]");
        (caller->*selector)(caller);
    }

コールバック関数の作成

• HelloWorldScene 側で、コールバック関数を作成します。

#include "MyLayer.h";
void HelloWorld::myCallback(CCObject* sender)
{
    CCLOG("[myCallback]");
}

コールバック関数を呼び出す関数の呼び出し

• HelloWorldScene 側で、MyLayer の側の、コールバック関数を引数とする関数を実行します。
• 起動時に実行されるように HelloWorldScene::init() 内に追記します。

    MyLayer* layer = MyLayer::create();
    layer->doCallback(this, my_selector(HelloWorld::myCallback));

実行

• シミュレーターで実行して動作を確認します。CCLOGで指定した文字列が表示されれば成功です。

コード

• 最終的に完成したコードは以下のようになります。

MyLayer.h

#ifndef MyGame_MyLayer_h
#define MyGame_MyLayer_h

#include "cocos2d.h"

USING_NS_CC;

/**
 * 関数ポインターの型名の宣言
 *   CCObject のメソッドであり、
 *   void 型を返し、
 *   CCObject* を引数として受け取る関数ポインターを、
 *   SEL_MySelector という型名で扱う
 */
typedef void (CCObject::* SEL_MySelector)(CCObject*);

/**
 * 関数ポインターを取得するマクロの宣言
 *   my_selector("関数名") と記述した場合に、
 *   指定した関数のポインターを SEL_MySelector 型のポインターとして扱う
 */
#define my_selector(_SELECTOR) (SEL_MySelector)(&_SELECTOR)

class MyLayer : public CCLayer
{
public:
    virtual bool init()
    {
        if (!CCLayer::init()) {
            return false;
        }
        return true;
    }
    CREATE_FUNC(MyLayer);
    
    void doCallback(CCObject* caller, SEL_MySelector selector)
    {
        CCLOG("[doCallback]");
        (caller->*selector)(caller);
    }
};

#endif

HelloWorldScene.h

#ifndef __HELLOWORLD_SCENE_H__
#define __HELLOWORLD_SCENE_H__

#include "cocos2d.h"
#include "MyLayer.h"

class HelloWorld : public cocos2d::CCLayer
{
public:
    // Here's a difference. Method 'init' in cocos2d-x returns bool, instead of returning 'id' in cocos2d-iphone
    virtual bool init();  

    // there's no 'id' in cpp, so we recommend returning the class instance pointer
    static cocos2d::CCScene* scene();
    
    // a selector callback
    void menuCloseCallback(CCObject* pSender);
    
    // implement the "static node()" method manually
    CREATE_FUNC(HelloWorld);
    

    void myCallback(CCObject* caller);
};

#endif // __HELLOWORLD_SCENE_H__

HelloWorldScene.cpp

#include "HelloWorldScene.h"

USING_NS_CC;

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

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

    // return the scene
    return scene;
}

// on "init" you need to initialize your instance
bool HelloWorld::init()
{
    //////////////////////////////
    // 1. super init first
    if ( !CCLayer::init() )
    {
        return false;
    }
    
    CCSize visibleSize = CCDirector::sharedDirector()->getVisibleSize();
    CCPoint origin = CCDirector::sharedDirector()->getVisibleOrigin();

    /////////////////////////////
    // 2. add a menu item with "X" image, which is clicked to quit the program
    //    you may modify it.

    // add a "close" icon to exit the progress. it's an autorelease object
    CCMenuItemImage *pCloseItem = CCMenuItemImage::create(
                                        "CloseNormal.png",
                                        "CloseSelected.png",
                                        this,
                                        menu_selector(HelloWorld::menuCloseCallback));
    
	pCloseItem->setPosition(ccp(origin.x + visibleSize.width - pCloseItem->getContentSize().width/2 ,
                                origin.y + pCloseItem->getContentSize().height/2));

    // create menu, it's an autorelease object
    CCMenu* pMenu = CCMenu::create(pCloseItem, NULL);
    pMenu->setPosition(CCPointZero);
    this->addChild(pMenu, 1);

    /////////////////////////////
    // 3. add your codes below...

    // add a label shows "Hello World"
    // create and initialize a label
    
    CCLabelTTF* pLabel = CCLabelTTF::create("Hello World", "Arial", 24);
    
    // position the label on the center of the screen
    pLabel->setPosition(ccp(origin.x + visibleSize.width/2,
                            origin.y + visibleSize.height - pLabel->getContentSize().height));

    // add the label as a child to this layer
    this->addChild(pLabel, 1);

    // add "HelloWorld" splash screen"
    CCSprite* pSprite = CCSprite::create("HelloWorld.png");

    // position the sprite on the center of the screen
    pSprite->setPosition(ccp(visibleSize.width/2 + origin.x, visibleSize.height/2 + origin.y));

    // add the sprite as a child to this layer
    this->addChild(pSprite, 0);
    
    
    /**
     * ★追記箇所
     * コールバック関数を呼び出す関数の呼び出し
     */
    MyLayer* layer = MyLayer::create();
    layer->doCallback(this, my_selector(HelloWorld::myCallback));
    
    return true;
}


void HelloWorld::menuCloseCallback(CCObject* pSender)
{
#if (CC_TARGET_PLATFORM == CC_PLATFORM_WINRT) || (CC_TARGET_PLATFORM == CC_PLATFORM_WP8)
	CCMessageBox("You pressed the close button. Windows Store Apps do not implement a close button.","Alert");
#else
    CCDirector::sharedDirector()->end();
#if (CC_TARGET_PLATFORM == CC_PLATFORM_IOS)
    exit(0);
#endif
#endif
}

/**
 * ★追記箇所
 * コールバック関数
 */
void HelloWorld::myCallback(CCObject* sender)
{
    CCLOG("[myCallback]");
}