cocos2dx[3.2](19)——裁剪節(jié)點(diǎn)ClippingNode

【嘮叨】

    學(xué)習(xí)cocos2dx 3.2確實(shí)比較吃力，因?yàn)榫W(wǎng)上關(guān)于最新版的v3.2的資料十分稀少，或者是講解的確實(shí)不是很詳細(xì)。大部分人都是根據(jù)官方文檔照樣畫(huà)瓢，而對(duì)于有些比較抽象的概念及函數(shù)都是照著官方文檔來(lái)講解的。這樣的結(jié)果，導(dǎo)致有些東西令我確實(shí)非常費(fèi)解。

    沒(méi)有辦法，只好自己來(lái)總結(jié)cocos2dx3.2，然后將個(gè)人的學(xué)習(xí)感悟分享給大家。

    PS：當(dāng)然有些大牛寫(xiě)的文章還是很不錯(cuò)的。

    有時(shí)候我們需要顯示一張圖片的部分區(qū)域，比如文字遮罩、圖片遮罩。。。

    本節(jié)要講的ClippingNode的功能效果大致就是上面所看到的遮罩效果。

【致謝】

    http://cn.cocos2d-x.org/article/index?type=cocos2d-x&url=/doc/cocos-docs-master/manual/framework/native/v3/ClippingNode/zh.md

    http://www.waitingfy.com/archives/1093 （“文字遮罩效果”）

    http://cn.cocos2d-x.org/tutorial/show?id=842 （“新手向?qū)А敝谱鳎?/strong>

【Demo下載】

    https://github.com/shahdza/Cocos_LearningTest/tree/master/demo_%E8%A3%81%E5%89%AA%E8%8A%82%E7%82%B9ClippingNode 

【v3.3】

    在v3.3版本中，新增了一個(gè) ClippingRectangleNode ：是ClippingNode的一個(gè)輕量版本。

    相比于 ClippingNode, 有一些優(yōu)點(diǎn)和缺點(diǎn):

        > 優(yōu)點(diǎn)：

            > 它不依賴于stencil buffer，這意味著它可以在更多的安卓設(shè)備上運(yùn)行

            > 性能更好

        > 缺點(diǎn)：

            > 只能用于裁剪矩形區(qū)域

【ClippingNode】

1、原理

    ClippingNode（裁剪節(jié)點(diǎn)）可以用來(lái)對(duì)節(jié)點(diǎn)進(jìn)行裁剪。ClippingNode是Node的子類，可以像普通節(jié)點(diǎn)一樣放入Layer，Scene，Node中。

    主要是根據(jù)一個(gè)模板（Stencil）切割圖片的節(jié)點(diǎn)，生成任何形狀的節(jié)點(diǎn)顯示。

    ClippingNode是利用模板遮罩來(lái)完成對(duì)Node區(qū)域裁剪的技術(shù)。

    如何理解ClippingNode的遮罩？看下圖的例子吧。

2、舉例說(shuō)明

    > 模板（Stencil）：可以使用Layer、Node、Sprite等。

    > 底板           ：可以使用Layer、Node、Sprite等。

    > Layer層

  2.1、第一組（Layer層無(wú)背景圖片）

    > 模板（Stencil）：模板為Node節(jié)點(diǎn)，放入5個(gè)Sprite的小球。

    > 底板           ：底板為Node節(jié)點(diǎn)，放入1個(gè)Sprite的ABCD圖。

    > Layer層        ：無(wú)元素，背景顏色為黑色。

    > 裁剪遮罩效果示意圖：

  2.2、第二組（Layer層有背景圖片）

    > 模板（Stencil）：模板為Node節(jié)點(diǎn)，放入5個(gè)Sprite的小球。

    > 底板           ：底板為Node節(jié)點(diǎn)，放入1個(gè)Sprite的ABCD圖。

    > Layer層        ：有一個(gè)Sprite的cocos2dx背景圖片。

    > 裁剪遮罩效果示意圖：

  2.3、分析總結(jié)

    通過(guò)ClippingNode進(jìn)行裁剪遮罩，其實(shí)是這樣的：

        > 將模板（Stencil）上所有元素的形狀集合作為“形狀模板”，其元素本身不渲染。

        > 使用“形狀模板”對(duì)底板進(jìn)行裁剪。

        > 顯示從底板上裁剪下來(lái)的圖片區(qū)域。

    總的來(lái)說(shuō)：

        > 模板（Stencil）相當(dāng)于是一個(gè)樣板，上面有很多不同形狀的"洞洞"。

        > 然后根據(jù)樣板，對(duì)底板進(jìn)行裁剪，"挖洞"。

        > 然后將剪下來(lái)的那些碎片，按照原來(lái)的位置進(jìn)行擺放。

    其中：模板（Stencil）只是一個(gè)“形狀模板”，本身的圖片是不進(jìn)行繪制的。

3、主要函數(shù)

    ClippingNode繼承于Node類，用于節(jié)點(diǎn)的裁剪與遮罩。

  3.1、創(chuàng)建ClippingNode

    兩種方式：是否使用模板（stencil）來(lái)創(chuàng)建。

//
	//創(chuàng)建，不含模板（stencil）
	ClippingNode* clippingNode = ClippingNode::create();

	//創(chuàng)建，使用模板（stencil）
	ClippingNode* clippingNode = ClippingNode::create(stencil);
//

  3.2、設(shè)置模板（Stencil）

    模板節(jié)點(diǎn)是Node的子類，一般常常使用DrawNode，因?yàn)樗梢岳L制不同形狀的圖形。當(dāng)然也可以直接使用Node節(jié)點(diǎn)作為作為模板。

//
/**
 *		用來(lái)做裁剪的模板（stencil）節(jié)點(diǎn)（Node）
 *		模板（stencil）對(duì)象，默認(rèn)為空（nullptr）
 **/
	Node* stencil = Node::create();    //模板stencil節(jié)點(diǎn)Node
	
	stencil->addChild(spriteBall1);    //添加小球1
	stencil->addChild(spriteBall2);    //添加小球2
	stencil->addChild(spriteBall3);    //添加小球3
	stencil->addChild(spriteBall4);    //添加小球4
	stencil->addChild(spriteBall5);    //添加小球5
	
	clippingNode->setStencil(stencil); //設(shè)置模板Stencil
//

  3.3、設(shè)置底板（Content）

//
	//創(chuàng)建ClippingNode后，使用addChild()添加的節(jié)點(diǎn)，即為底板內(nèi)容
	clippingNode->addChild(content); //設(shè)置底板
//

  3.4、倒置顯示（Inverted）

    > false ：顯示被模板裁剪下來(lái)的底板內(nèi)容。默認(rèn)為false。

    > true  ：顯示剩余部分。

//
	//默認(rèn)為false
	//表示顯示被裁剪下來(lái)的底板內(nèi)容
	clippingNode->setInverted(false);
//

  3.5、alpha閾值（alphaThreshold）

    > alpha：表示像素的透明度值。

    > 只有模板（stencil）中像素的alpha值大于alpha閾值時(shí)，內(nèi)容才會(huì)被繪制。

    > alpha閾值（alphaThreshold）：取值范圍[0,1]。

    > 默認(rèn)為 1 ，表示alpha測(cè)試默認(rèn)關(guān)閉，即全部繪制。

    > 若不是1  ，表示只繪制模板中，alpha像素大于alphaThreshold的內(nèi)容。

//
	//設(shè)置alpha透明度閘值
	//即顯示模板中，alpha像素大于0.05的內(nèi)容
	holesClipper->setAlphaThreshold(0.05f); 
//

  具體說(shuō)明：

    以下是一張40*40的圖片，其中小球以外的其他區(qū)域像素為透明的（即：alpha為 0 ）。

    （1）在不設(shè)置AlphaThreshold閘值，或者setAlphaThreshold(1.0f)，的情況下：

    （2）在設(shè)置setAlphaThreshold(0.5f)，的情況下：

    （3）結(jié)論：

        > 可以發(fā)現(xiàn)在不設(shè)置alpha閘值時(shí)，模板繪制的區(qū)域?yàn)橐粋€(gè)40*40的矩形。

        > 設(shè)置了alpha閘值為0.5時(shí)，透明度alpha為0的像素不被繪制，只繪制了一個(gè)小圓。

【代碼實(shí)戰(zhàn)】

    這里講幾個(gè)有意思的例子。

    > 官方的“打洞”

    > “文字遮罩閃亮特效”

    > ClippingNode類的用途很廣泛，更多用法自行百度。

1、官方的“打洞”

    官方cpp-test項(xiàng)目里有一個(gè)使用ClippingNode完成“打洞”效果的例子，我覺(jué)得挺有意思的。

    更多的用法參見(jiàn)官方的cpp-test項(xiàng)目。

    先來(lái)看看效果：

  1.1、素材

  1.2、在HelloWorld.h中添加如下變量與函數(shù)

//
	ClippingNode* holesClipper; //裁剪節(jié)點(diǎn)
	Node* holesStencil;         //模板節(jié)點(diǎn)
	Node* holes;                //底板節(jié)點(diǎn)
	 
	//觸摸回調(diào)
	void onTouchesBegan(const std::vector<Touch*>& touches, Event *unused_event);
	//添加小洞
	void pokeHoleAtPoint(Vec2 point);
//

  1.3、在HelloWorld.cpp中的init()中創(chuàng)建裁剪節(jié)點(diǎn)ClippingNode

//
//[1].背景圖片(Layer層中)
	Sprite* bg = Sprite::create("HelloWorld.png");
	bg->setPosition(visibleSize / 2);
	this->addChild(bg);


//[2].創(chuàng)建裁剪節(jié)點(diǎn) : holesClipper
	holesClipper = ClippingNode::create();
	holesClipper->setPosition(visibleSize / 2);
	this->addChild(holesClipper);

	//屬性設(shè)置
	holesClipper->setInverted(true);        //倒置顯示，未被裁剪下來(lái)的剩余部分
	holesClipper->setAlphaThreshold(0.5f);  //設(shè)置alpha透明度閘值
	holesClipper->runAction(RepeatForever::create(RotateBy::create(1, 45))); //旋轉(zhuǎn)動(dòng)作


//[3].創(chuàng)建模板 : holesStencil
	holesStencil = Node::create();
	holesClipper->setStencil(holesStencil); //設(shè)置模板節(jié)點(diǎn)

	//添加一個(gè)模板遮罩 ball
	holesStencil->addChild(Sprite::create("ball.png"), -1);


//[4].創(chuàng)建底板 : holes
	holes = Node::create();
	holesClipper->addChild(holes); //設(shè)置底板

	//添加另一個(gè)底板內(nèi)容 blocks
	Sprite* content = Sprite::create("blocks.png");
	holesClipper->addChild(content, -1, "content");


//[5].觸摸事件
	auto listener = EventListenerTouchAllAtOnce::create();
	listener->onTouchesBegan = CC_CALLBACK_2(HelloWorld::onTouchesBegan, this);
	_eventDispatcher->addEventListenerWithSceneGraphPriority(listener, this);
//

  1.4、設(shè)置觸摸事件回調(diào)。當(dāng)觸摸點(diǎn)在底板區(qū)域內(nèi)部，則“打洞”

//
void HelloWorld::onTouchesBegan(const std::vector<Touch*>& touches, Event *unused_event)
{
//[1].獲取觸點(diǎn), 轉(zhuǎn)換為相對(duì)holesClipper節(jié)點(diǎn)的 相對(duì)坐標(biāo)
	Vec2 point = touches[0]->getLocation();
	point = holesClipper->convertToNodeSpace(point);

	
//[2].獲取底板區(qū)域矩形Rect
	Sprite* content = (Sprite*)holesClipper->getChildByName("content");
	Size contentSize = content->getContentSize();
	Rect rect = Rect(-contentSize.width / 2, -contentSize.height / 2, contentSize.width, contentSize.height);

	
//[3].觸摸點(diǎn)在底板內(nèi)部, 進(jìn)行"打洞"
	if (rect.containsPoint(point))
	{
		pokeHoleAtPoint(point);
	}
}
//

  1.5、實(shí)現(xiàn)“打洞”操作函數(shù)

//
void HelloWorld::pokeHoleAtPoint(Vec2 point)
{
	CCLOG("Add a Hole!!!");

//[1].添加底板內(nèi)容 : 一個(gè)洞的痕跡
	auto hole = Sprite::create("hole_effect.png");
	hole->setPosition(point);
	holes->addChild(hole);


//[2].添加模板內(nèi)容 : 一個(gè)小洞
	auto holeStencil = Sprite::create("hole_stencil.png");
	holeStencil->setPosition(point);
	holesStencil->addChild(holeStencil);


//[3].動(dòng)作效果 : 放大縮小
	holesClipper->runAction(Sequence::create(ScaleTo::create(0.05f, 1.05f), ScaleTo::create(0.05f, 1.0f), NULL));
}
//

  1.6、分析與總結(jié)

    這里設(shè)置了倒置顯示（Inverted），即使用模板對(duì)底板進(jìn)行裁剪后，顯示未被剪下的剩余部分。

    （1）模板Stencil：

    （2）底板：

    （3）裁剪遮罩效果圖：

        顯示未被模板裁剪的剩余部分。

2、“文字遮罩特效”

    先來(lái)看看效果：

  2.1、素材

  2.2、代碼實(shí)現(xiàn)

//
//[1].背景圖片
	Sprite* bg = Sprite::create("HelloWorld.png");
	bg->setPosition(visibleSize / 2);
	this->addChild(bg, -1);


//[2].創(chuàng)建主題文字 : gameTitle
	Sprite* gameTitle = Sprite::create("game_title.png");

	//獲取尺寸大小
	Size clipSize = gameTitle->getContentSize();


//[3].創(chuàng)建底板的發(fā)光圖片 : spark
	Sprite* spark = Sprite::create("spark.png");
	spark->setPosition(-clipSize.width, 0);


//[4].創(chuàng)建裁剪節(jié)點(diǎn) : clippingNode
	ClippingNode* clippingNode = ClippingNode::create();
	clippingNode->setPosition(visibleSize / 2);
	this->addChild(clippingNode);

	clippingNode->setAlphaThreshold(0.05f); //設(shè)置alpha閘值
	clippingNode->setContentSize(clipSize); //設(shè)置尺寸大小

	clippingNode->setStencil(gameTitle);   //設(shè)置模板stencil
	clippingNode->addChild(gameTitle, 1);  //先添加標(biāo)題,會(huì)完全顯示出來(lái),因?yàn)楦０逡粯哟笮?	clippingNode->addChild(spark,2);       //會(huì)被裁減


//[5].左右移動(dòng)spark
	MoveTo* moveAction = MoveTo::create(2.0f, Vec2(clipSize.width, 0));
	MoveTo* moveBackAction = MoveTo::create(2.0f, Vec2(-clipSize.width, 0));
	spark->runAction(RepeatForever::create(Sequence::create(moveAction, moveBackAction, NULL)));
//

  2.3、分析與總結(jié)

    實(shí)際上就是將文字作為模板Stencil，做出文字的“形狀模板”，然后去裁剪底板。

    而底板則是由文字、發(fā)光棒組合而成，然后移動(dòng)發(fā)光棒，就可以呈現(xiàn)文字發(fā)光的效果。

    （1）模板Stencil：

    （2）底板：

    （3）剪裁遮罩效果圖：