Cocos2d-x中__Array容器以及实例介绍

__Array类在Cocos2d-x 2.x时代它就是CCArray类。它是模仿Objective-C中的NSArray类而设计的通过引用计数管理内存。__Array继承于Ref类因此它所能容纳的是Ref及子类所创建的对象指针。


1、创建__Array对象
创建__Array对象有很多函数下面是总结常用的函数
static __Array* create()。创建__Array。
static __Array* create(Ref* object, …)。使用一系列Ref创建__Array。
static __Array* createWithObject(Ref * object)。使用一个Ref创建__Array。 
static __Array* createWithCapacity(unsigned int capacity)。创建__Array并设置容量。
static __Array* createWith__Array(__Array* other__Array)。用一个已存在的__Array创建另一个__Array。 
static __Array* createWithContentsOfFile(const std::string &pFileName) 。从属性列表文件创建__Array。  


2、添加元素
向__Array对象中添加元素都必须是Ref和其子类的对象指针类型下面是总结常用的函数
void addObject(Ref* object)。添加一个元素。  
void addObjectsFromArray(__Array* otherArray)。把一个__Array对象中所有元素添加到当前__Array对象中。
void insertObject(Ref* object, ssize_t index)。在指定位置插入元素ssize_t是int类型别名。


3、移除元素
下面是总结常用的移除__Array容器中元素的函数
void removeLastObject()。移除最后一个元素。
void removeObject(Ref* object)。移除某个元素。  
void removeObjectAtIndex(ssize_t index)。移除一个指定位置的元素。
void removeObjectsInArray(__Array* otherArray)。移除某个数组__Array对象。 
void removeAllObjects()。移除所有元素。 
void fastRemoveObject(Ref* object)。快速移除某个元素。 
void fastRemoveObjectAtIndex(ssize_t index)。快速移除某个指定位置的元素。


4、替换和交换元素
我们还可以通过下面函数对__Array容器中元素替换和交换
void exchangeObject(Ref* object1, Ref* object2)。交换2个元素。 
void exchangeObjectAtIndex(ssize_t index1, ssize_t index2)。交换2个指定位置元素。 
void replaceObjectAtIndex(ssize_t uIndex, Ref* object)。用一个对象替代指定位置元素。


5、其它操作函数
此外还有很多操作__Array对象的函数下面是总结常用的函数
ssize_t count()。返回元素个数。 
ssize_t capacity()。返回__Array的容量。 
ssize_t indexOfObject(Ref* object)。返回指定Ref对象指针的位置。
Ref* objectAtIndex(ssize_t index)。返回指定位置的Ref对象指针。
Ref* lastObject()。返回最后一个元素。 
Ref* randomObject()。返回随机元素。 
bool containsObject(Ref* object)。返回某个元素是否存在于__Array容器中。
bool isEqualToArray(__Array* pOtherArray)。判断__Array对象是否相等。 
void reverseObjects()。反转__Array容器。 


6、遍历__Array容器
Cocos2d-x提供了两个遍历__Array容器的宏
CCARRAY_FOREACH。正向遍历。
CCARRAY_FOREACH_REVERSE。反向遍历。


实例__Array容器
下面我们通过一个实例介绍__Array容器中的相关函数。如图所示场景点击右下角的Go按钮在场景中添加100个精灵。 



要实现上述功能我们可以不使用__Array但是为了熟悉__Array类我们在本例实现中特意使用了__Array类。
下面我们看看代码部分HelloWorldScene.h代码如下 

#ifndef __HELLOWORLD_SCENE_H__
#define __HELLOWORLD_SCENE_H__


#include "cocos2d.h"


#define MAX_COUNT 100												①


class HelloWorld : public cocos2d::Layer
{
	cocos2d::__Array* list;												②
public:


	~HelloWorld();														③
    static cocos2d::Scene* createScene();
    virtual bool init();  
    
    void menuCloseCallback(cocos2d::Ref* pSender);
    
    CREATE_FUNC(HelloWorld);
};


#endif // __HELLOWORLD_SCENE_H__

上述代码第①行代码#define MAX_COUNT 100定义宏MAX_COUNTMAX_COUNT定义了一次生成的精灵数。第②行代码声明__Array*的成员变量list。第③行代码是声明析构函数我们需要在析构函数中释放成员变量list。
HelloWorldScene.cpp中的init函数代码如下

bool HelloWorld::init()
{
	if ( !Layer::init() )
	{
		return false;
	}


	Size visibleSize = Director::getInstance()->getVisibleSize();
	Vec2 origin = Director::getInstance()->getVisibleOrigin();


	auto goItem = MenuItemImage::create(
		"go-down.png",
		"go-up.png",
		CC_CALLBACK_1(HelloWorld::menuCloseCallback, this));


	goItem->setPosition(Vec2(origin.x + visibleSize.width - goItem->getContentSize().width/2 ,
		origin.y + goItem->getContentSize().height/2));


	auto menu = Menu::create(goItem, NULL);
	menu->setPosition(Vec2::ZERO);
	this->addChild(menu, 1);


	this->list  = __Array::createWithCapacity(MAX_COUNT);							①
	this->list->retain();													②


	for(int i = 0;i < MAX_COUNT; ++i){										
		Sprite* sprite = Sprite::create("Ball.png");									③
		this->list->addObject(sprite);											④
	}


	return true;
}

init是初始化场景的函数我们在该函数中创建了100个精灵并把它们放到__Array*类型的list成员变量中。其中第①行代码是创建__Array*类型的list成员变量使用createWithCapacity函数其中的参数是list容器的初始化容量。第②行代码this->list->retain()非常重要采用静态函数createWithCapacity创建的list容器对象是autorelease的如果不调用retain()函数保持内存当init函数结束时候list容器对象会自动释放这样在其它函数中再使用list容器对象就会出错。第③行代码是循环创建精灵对象第④行代码是将精灵添加到list容器对象中但是需要注意的是这些精灵对象还没有被添加到场景中因此场景显示的时候它们是不出现的。
HelloWorldScene.cpp中的menuCloseCallback函数代码如下

void HelloWorld::menuCloseCallback(Ref* pSender)
{
	
	log("list->count() = %d",this->list->count());
	Size visibleSize = Director::getInstance()->getVisibleSize();


	Ref* obj = nullptr;


	CCARRAY_FOREACH(this->list, obj) {										①
		
		Sprite* sprite = (Sprite*)obj;											②


		int x = CCRANDOM_0_1() * visibleSize.width;								③
		int y = CCRANDOM_0_1() * visibleSize.height;								④


		sprite->setPosition( Vec2(x, y) );
		this->removeChild(sprite);
		this->addChild(sprite);
	}


}

该函数是在玩家触摸Go按钮之后调用的函数其中第①行代码是使用CCARRAY_FOREACH宏循环遍历list容器中的数据。第②行代码是Sprite* sprite = (Sprite*)obj获得精灵对象。第③行代码CCRANDOM_0_1() * visibleSize.width是随机产生x轴坐标CCRANDOM_0_1()是产生0~1之间的随机数的宏。类似第④行代码是随机产生精灵的y轴坐标。
HelloWorldScene.cpp中的析构函数代码如下

HelloWorld::~HelloWorld()
{
	this->list->removeAllObjects();											①
	CC_SAFE_RELEASE_NULL(this->list);										②
}

在析构函数中要释放一些资源第①行代码this->list->removeAllObjects()是移除list容器中的所有对象但是这还没有释放list容器对象本身。第②行代码CC_SAFE_RELEASE_NULL(this->list)是安全释放成员变量list容器对象。其中的CC_SAFE_RELEASE_NULL是将list容器对象先释放然后再赋予nullptr。