现在的位置: 首页 > 综合 > 正文

CocosBuilder使用技巧

2019年09月25日 ⁄ 综合 ⁄ 共 7638字 ⁄ 字号 评论关闭

CocosBuilder使用技巧

2015年02月05日


基础篇

首先申明的是,这片文章不是教你如何新建cocosbuilder工程,如何摆放各种控件,如何设置Action等。诸如此类,大家可以快速的Google出N多文章。我在这里只是抒发一些自己使用CocosBuilder的心得,仅此而已。本文面向有一定C++基础和cocos2d-x经验的程序员,如果你使用cocos2d-iphone,可以直接忽略本文。另外本文所介绍的内容,在目前开发过程中还没有遇到问题,若有不完善的地方,还请大家指正。

首先来看CCSpriteLoader,这个是用来解析CCSprite的CCB类,我们可以看到它里面有两个宏:

CCB_STATIC_NEW_AUTORELEASE_OBJECT_METHOD(CCSpriteLoader, loader);    
protected:
CCB_VIRTUAL_NEW_AUTORELEASE_CREATECCNODE_METHOD(CCSprite);

第一个宏用来为CCSpriteLoader声明一个static返回本身实例的loader函数。相当如CCSprite的create函数。第二个函数声明一个createCCNode的函数,返回的是自己所要构建的Node类型,也就是简单的调用CCSprite的create();

第一个函数是用来注册loader类的,如果CCBReader解析ccb文件时遇到一个CCSprite的类,那么这个loader函数就会调用,得到一个CCSpriteLoader来处理所遇到的属性,然后这个loader会创建出一个自己的负责导出的Node类型,也就是CCSprite来传递给自己的各个解析函数,由它们来根据不同的配置设置CCSprite的对应属性。

这是注册loader的代码:

void CCNodeLoaderLibrary::registerDefaultCCNodeLoaders() {
  this->registerCCNodeLoader("CCSprite", CCSpriteLoader::loader());
}

这是查找loader并处理的代码:

CCNodeLoader *ccNodeLoader = this->mCCNodeLoaderLibrary->getCCNodeLoader(className.c_str());
                                                                                           
    if (! ccNodeLoader)
    {
        CCLog("no corresponding node loader for %s", className.c_str());
        return NULL;
    }
                                                                                      
    CCNode *node = ccNodeLoader->loadCCNode(pParent, this);

注意下面的那个loaderCCNode函数,就是它返回了一个Node类型。可以猜出它肯定调用了之前声明的那个createCCNode()函数。

CCNode * CCNodeLoader::loadCCNode(CCNode * pParent, CCBReader * pCCBReader) {
    CCNode * ccNode = this->createCCNode(pParent, pCCBReader);
                                                                               
    //this->parseProperties(ccNode, pParent, pCCBReader);
                                                                               
    return ccNode;
}

有意思的是那句被注释掉的语句,按理来说创建出一个node,然后解析出属性返回就ok了,为什么不再这里进行这一步呢?在外层函数中,它先处理了这个node的animation设置,然后再调用了那句parseProperties(),或许这其中有些属性具有顺序依赖吧。而那句parseProperties函数正是用来解析各种属性的,由于C++的静态特性,可想而知这个函数是一个大的嵌套if-else,翻开源码一看还夹杂着switch语句(再怎么黑C++都不过分啊!)。

其中一个处理postion的函数如下:

void CCNodeLoader::onHandlePropTypePosition(CCNode * pNode, CCNode * pParent, const char* pPropertyName, CCPoint pPosition, CCBReader * pCCBReader) {
    if(strcmp(pPropertyName, PROPERTY_POSITION) == 0) {
        pNode->setPosition(pPosition);
    } else {
        ASSERT_FAIL_UNEXPECTED_PROPERTY(pPropertyName);
    }
}

到此,cocos2d-x来处理CCB文件的工作流便清晰了。其实思想是朴素的(用了C++还想挽个什么花~~),代码或许迷乱了些。(下面是CCNodeLoader头文件的部分截图)

框架篇

在使用CocosBuilder的时候一般root node都是CCLayer,而且Layer都习惯写上Custom Class。这样如果导入一个ccb文件,就可以直接创建出一个对应的实例来,很自动化,很爽。但是如果要写上Custom Class,那么就得为这个class注册一个loader,要写一个loader,就要写上那两个宏,而且还要加上一个loader的头文件。(官方做法)其实我真正需要的只是dynamic_cast到我的Custom Class而已,而且不需要做任何额外的parseProperties。而且我觉得cocos2d-x的宏用的过多了一些,当然我也用的很多,但是如果能够用泛型解决的问题,我都不会用宏来做。经过实践,我觉得用模板来做这个工作很是方便,因此介绍给大家。

首先创建一个create()函数,可以使用一个模板解决,应为这个函数都是静态外部调用的,没有必要每次在class里面额外声明一个:

template <typename T> class Template_creator
{
public:
  static T* create(){
    T* ptr = new T();
    if(ptr != nullptr && ptr->init()){
      ptr->autorelease();
      return ptr;
    }
    CC_SAFE_DELETE(ptr);
    return nullptr;
  };
};

要吐槽的是cocos2d-x的init函数,这个函数在很长的一段时间里面不是virtual的。现在改过来了,但是我还是要狠狠地吐槽一下。接下来我们写一个模板的loader。如果仅仅是CCLayer的loader就太不Temlate了,可以为它指定一个ParentLoader来继承,那就通用多了。代码如下:

class CCBLoader;
template<typename NodeType, typename ParentLoader = typename CCBLoaderTraits<NodeType>::ParentLoader>
class TemplateLoader : public ParentLoader
{
public:
  static TemplateLoader<NodeType>* loader() {
    TemplateLoader<NodeType>* ptr = new TemplateLoader<NodeType>();
    if(ptr != nullptr) {
      ptr->autorelease();
      return ptr;
    }
    CC_SAFE_DELETE(ptr);
    return  nullptr;
  };
                                                               
protected:
  virtual NodeType* createCCNode(cocos2d::CCNode * pParent, cocos2d::extension::CCBReader* pCCBReader) {
    return Template_creator<NodeType>::create();
  }
};

这里用到了一个CCBLoaderTraits,因为基本上是一一对应的关系,也是经典的用Traits的场合。

template<typename T>
class CCBLoaderTraits
{
public:
  typedef T NodeType;
  typedef typename cocos2d::extension::CCLayerLoader ParentLoader;
};

那么注册一个loader现在就很方便了:

CCNodeLoaderLibrary * node_loader_library = CCNodeLoaderLibrary::sharedCCNodeLoaderLibrary();
node_loader_library->registerCCNodeLoader(“MainGameLayer”, TemplateLoader::loader());如果申明一个宏的话,代码就会更加的直观:

#define REGISTER_CCB_LOADER(name) { \
node_loader_library->registerCCNodeLoader(#name, TemplateLoader<name>::loader()); }
......
REGISTER_CCB_LOADER(MainGameLayer);

到此,应该是再无所求。新建一个CCLayer的Custom Class只需要简单的注册一遍就OK了。

再看MainGameLayer这个类,让他继承一个BaseCCBLayer:

class BaseCCBLayer : public cocos2d::CCLayer,
public cocos2d::extension::CCBSelectorResolver,
public cocos2d::extension::CCBMemberVariableAssigner,
public cocos2d::extension::CCNodeLoaderListener
{
public:
  virtual ~BaseCCBLayer(){};
  virtual cocos2d::SEL_MenuHandler onResolveCCBCCMenuItemSelector(cocos2d::CCObject * pTarget, const char* pSelectorName) override { return nullptr; };
  virtual cocos2d::extension::SEL_CCControlHandler onResolveCCBCCControlSelector(cocos2d::CCObject * pTarget, const char* pSelectorName) override { return nullptr; };
  virtual bool onAssignCCBMemberVariable(CCObject* pTarget, const char* pMemberVariableName, CCNode* pNode) override {
    return false;
  };
  virtual void onNodeLoaded(cocos2d::CCNode * node, cocos2d::extension::CCNodeLoader * node_loader) override {  };
};

这样做有点小方便,而且在cocos2d-x中多重继承一不小心就会出现很诡异的错误。这样做可以稍微避免掉一些。

使用篇

上面利用Custom Layer来介绍了下如何使用Template搭建一个框架,这篇主要介绍一些如何更多的使用这个框架(不是使用CocosBuilder哦)。大家可以看到这个架构的易用性和可扩展性都是不错的。首先最为基础的就是如下几个回调类:

cocos2d::extension::CCBSelectorResolver
cocos2d::extension::CCBMemberVariableAssigner
cocos2d::extension::CCNodeLoaderListener

这几个是基本的,使用方法或多或少应有所了解。要注意的是CCB文件中要选好assign target。对于CCBMemberVariableAssigner,他有两个辅助宏,week宏在析构的时候不需要手动调用release。另外对于有多个相同的Variable,我推荐使用custom properties来设置tag,然后在nodeloaded函数中遍历children,使用dynamic_cast转型来赋值。下面通过一个例子来介绍如何使用custom properties。

例如,有时候我需要在屏幕上设置一个坐标。需要这么做一部分也是因为CocosBuilder的Node Type不全,或者有其他特殊的需求。我当然可以设置一个Node,然后assign一个tag就可以了。但是为了使用方便,我使用了一个PositionNode的Custom Node:

class PositionNode : public cocos2d::CCNode,
public cocos2d::extension::CCBMemberVariableAssigner
{
public:
  PositionNode() = default;
  virtual ~PositionNode();
  virtual bool init();
  virtual bool onAssignCCBMemberVariable(CCObject* pTarget, const char* pMemberVariableName, CCNode* pNode) override { return false; }
  virtual bool onAssignCCBCustomProperty(CCObject* pTarget, const char* pMemberVariableName, cocos2d::extension::CCBValue* pCCBValue) override;
friend class PositonNodeManager;
private:
  std::string tag_;
};
                                                                          
template<>
class CCBLoaderTraits<PositionNode>
{
public:
  typedef PositionNode NodeType;
  typedef typename cocos2d::extension::CCNodeLoader ParentLoader;
};

对应的.cc文件:

#define kNodeTag ("node_tag")
                                                                   
PositionNode::~PositionNode() {
  PositionNodeManager::sharedPositionNodeManager()->RemovePositionNode(this);
}
                                                                   
bool PositionNode::init() {
  RETURN_FALSE_IF_FAILED(CCNode::init());
  return true;
}
                                                                   
bool PositionNode::onAssignCCBCustomProperty(cocos2d::CCObject *pTarget, const char *pMemberVariableName, cocos2d::extension::CCBValue *pCCBValue) {
  if (pTarget == this && strcmp(pMemberVariableName, kNodeTag) == 0) {
    this->tag_ = pCCBValue->getStringValue();
    PositionNodeManager::sharedPositionNodeManager()->PresentPositionNode(this);
    return true;
  }
  return false;
}

对于PositionNodeManager只需要提供如下接口就可以了:

public:
  cocos2d::CCPoint GetNodePosition(const char* tag);
  friend class PositionNode;
private:
  void PresentPositionNode(PositionNode*);
  void RemovePositionNode(PositionNode*);

这样,每次想要pos的时候,使用对应的node_tag就能够取到坐标点。代码复用,一劳永逸!当然具体实现的时候注意重入问题。想要能工作,还需要REGISTER一下即可。这是是使用非Layer的custom node的情形。

还有一种情况就是,我需要改写某些原生Node的properties,比如说一个Background,他是根据关卡不同而变化的。但是如果我在CocosBuilder中指定了frame,那就载入的时候多余创建了一个sprite,如果不加又看不到效果。这时通过重载它处理frame属性的函数轻松解决:

class BackgroundNode : public cocos2d::CCSprite,
public cocos2d::extension::CCBMemberVariableAssigner
{
public:
  BackgroundNode();
  virtual ~BackgroundNode();
  virtual bool init();
};
                                 
class BackgroundNodeLoader : public cocos2d::extension::CCSpriteLoader
{
  virtual void onHandlePropTypeSpriteFrame(CCNode * pNode, CCNode * pParent, const char * pPropertyName, CCSpriteFrame * pCCSpriteFrame, CCBReader * pCCBReader) {
    if(strcmp(pPropertyName, "displayFrame") == 0) {
      //backgrond node will init it's frame after tag assigned;
    } else {
      CCNodeLoader::onHandlePropTypeSpriteFrame(pNode, pParent, pPropertyName, pCCSpriteFrame, pCCBReader);
    }
  }
};
                                 
template<>
class CCBLoaderTraits<BackgroundNode>
{
public:
  typedef BackgroundNode NodeType;
  typedef BackgroundNodeLoader ParentLoader;
};

可见泛型框架来处理各种Loader都是没有问题的。

抱歉!评论已关闭.