【嘮叨】
學習cocos2dx 3.2確實比較喫力,因爲網上關於最新版的v3.2的資料十分稀少,或者是講解的確實不是很詳細。大部分人都是根據官方文檔照樣畫瓢,而對於有些比較抽象的概念及函數都是照着官方文檔來講解的。這樣的結果,導致有些東西令我確實非常費解。
沒有辦法,只好自己來總結cocos2dx3.2,然後將個人的學習感悟分享給大家。
PS:當然有些大牛寫的文章還是很不錯的。
有時候我們需要顯示一張圖片的部分區域,比如文字遮罩、圖片遮罩。。。
本節要講的ClippingNode的功能效果大致就是上面所看到的遮罩效果。
【致謝】
http://www.waitingfy.com/archives/1093 (“文字遮罩效果”)
http://cn.cocos2d-x.org/tutorial/show?id=842 (“新手嚮導”製作)
【Demo下載】
【v3.3】
在v3.3版本中,新增了一個 ClippingRectangleNode :是ClippingNode的一個輕量版本。
相比於 ClippingNode, 有一些優點和缺點:
> 優點:
> 它不依賴於stencil buffer,這意味着它可以在更多的安卓設備上運行
> 性能更好
> 缺點:
> 只能用於裁剪矩形區域
【ClippingNode】
1、原理
ClippingNode(裁剪節點)可以用來對節點進行裁剪。ClippingNode是Node的子類,可以像普通節點一樣放入Layer,Scene,Node中。
主要是根據一個模板(Stencil)切割圖片的節點,生成任何形狀的節點顯示。
ClippingNode是利用模板遮罩來完成對Node區域裁剪的技術。
如何理解ClippingNode的遮罩?看下圖的例子吧。
2、舉例說明
> 模板(Stencil):可以使用Layer、Node、Sprite等。
> 底板 :可以使用Layer、Node、Sprite等。
> Layer層
2.1、第一組(Layer層無背景圖片)
> 模板(Stencil):模板爲Node節點,放入5個Sprite的小球。
> 底板 :底板爲Node節點,放入1個Sprite的ABCD圖。
> Layer層 :無元素,背景顏色爲黑色。
> 裁剪遮罩效果示意圖:
2.2、第二組(Layer層有背景圖片)
> 模板(Stencil):模板爲Node節點,放入5個Sprite的小球。
> 底板 :底板爲Node節點,放入1個Sprite的ABCD圖。
> Layer層 :有一個Sprite的cocos2dx背景圖片。
> 裁剪遮罩效果示意圖:
2.3、分析總結
通過ClippingNode進行裁剪遮罩,其實是這樣的:
> 將模板(Stencil)上所有元素的形狀集合作爲“形狀模板”,其元素本身不渲染。
> 使用“形狀模板”對底板進行裁剪。
> 顯示從底板上裁剪下來的圖片區域。
總的來說:
> 模板(Stencil)相當於是一個樣板,上面有很多不同形狀的"洞洞"。
> 然後根據樣板,對底板進行裁剪,"挖洞"。
> 然後將剪下來的那些碎片,按照原來的位置進行擺放。
其中:模板(Stencil)只是一個“形狀模板”,本身的圖片是不進行繪製的。
3、主要函數
ClippingNode繼承於Node類,用於節點的裁剪與遮罩。
3.1、創建ClippingNode
兩種方式:是否使用模板(stencil)來創建。
//
//創建,不含模板(stencil)
ClippingNode* clippingNode = ClippingNode::create();
//創建,使用模板(stencil)
ClippingNode* clippingNode = ClippingNode::create(stencil);
//
3.2、設置模板(Stencil)
模板節點是Node的子類,一般常常使用DrawNode,因爲它可以繪製不同形狀的圖形。當然也可以直接使用Node節點作爲作爲模板。
//
/**
* 用來做裁剪的模板(stencil)節點(Node)
* 模板(stencil)對象,默認爲空(nullptr)
**/
Node* stencil = Node::create(); //模板stencil節點Node
stencil->addChild(spriteBall1); //添加小球1
stencil->addChild(spriteBall2); //添加小球2
stencil->addChild(spriteBall3); //添加小球3
stencil->addChild(spriteBall4); //添加小球4
stencil->addChild(spriteBall5); //添加小球5
clippingNode->setStencil(stencil); //設置模板Stencil
//
3.3、設置底板(Content)
//
//創建ClippingNode後,使用addChild()添加的節點,即爲底板內容
clippingNode->addChild(content); //設置底板
//
3.4、倒置顯示(Inverted)
> false :顯示被模板裁剪下來的底板內容。默認爲false。
> true :顯示剩餘部分。
//
//默認爲false
//表示顯示被裁剪下來的底板內容
clippingNode->setInverted(false);
//
3.5、alpha閾值(alphaThreshold)
> alpha:表示像素的透明度值。
> 只有模板(stencil)中像素的alpha值大於alpha閾值時,內容纔會被繪製。
> alpha閾值(alphaThreshold):取值範圍[0,1]。
> 默認爲 1 ,表示alpha測試默認關閉,即全部繪製。
> 若不是1 ,表示只繪製模板中,alpha像素大於alphaThreshold的內容。
//
//設置alpha透明度閘值
//即顯示模板中,alpha像素大於0.05的內容
holesClipper->setAlphaThreshold(0.05f);
//
具體說明:
以下是一張40*40的圖片,其中小球以外的其他區域像素爲透明的(即:alpha爲 0 )。
(1)在不設置AlphaThreshold閘值,或者setAlphaThreshold(1.0f),的情況下:
(2)在設置setAlphaThreshold(0.5f),的情況下:
(3)結論:
> 可以發現在不設置alpha閘值時,模板繪製的區域爲一個40*40的矩形。
> 設置了alpha閘值爲0.5時,透明度alpha爲0的像素不被繪製,只繪製了一個小圓。
【代碼實戰】
這裏講幾個有意思的例子。
> 官方的“打洞”
> “文字遮罩閃亮特效”
> ClippingNode類的用途很廣泛,更多用法自行百度。
1、官方的“打洞”
官方cpp-test項目裏有一個使用ClippingNode完成“打洞”效果的例子,我覺得挺有意思的。
更多的用法參見官方的cpp-test項目。
先來看看效果:
1.1、素材
1.2、在HelloWorld.h中添加如下變量與函數
//
ClippingNode* holesClipper; //裁剪節點
Node* holesStencil; //模板節點
Node* holes; //底板節點
//觸摸回調
void onTouchesBegan(const std::vector<Touch*>& touches, Event *unused_event);
//添加小洞
void pokeHoleAtPoint(Vec2 point);
//
1.3、在HelloWorld.cpp中的init()中創建裁剪節點ClippingNode
//
//[1].背景圖片(Layer層中)
Sprite* bg = Sprite::create("HelloWorld.png");
bg->setPosition(visibleSize / 2);
this->addChild(bg);
//[2].創建裁剪節點 : holesClipper
holesClipper = ClippingNode::create();
holesClipper->setPosition(visibleSize / 2);
this->addChild(holesClipper);
//屬性設置
holesClipper->setInverted(true); //倒置顯示,未被裁剪下來的剩餘部分
holesClipper->setAlphaThreshold(0.5f); //設置alpha透明度閘值
holesClipper->runAction(RepeatForever::create(RotateBy::create(1, 45))); //旋轉動作
//[3].創建模板 : holesStencil
holesStencil = Node::create();
holesClipper->setStencil(holesStencil); //設置模板節點
//添加一個模板遮罩 ball
holesStencil->addChild(Sprite::create("ball.png"), -1);
//[4].創建底板 : holes
holes = Node::create();
holesClipper->addChild(holes); //設置底板
//添加另一個底板內容 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、設置觸摸事件回調。當觸摸點在底板區域內部,則“打洞”
//
void HelloWorld::onTouchesBegan(const std::vector<Touch*>& touches, Event *unused_event)
{
//[1].獲取觸點, 轉換爲相對holesClipper節點的 相對座標
Vec2 point = touches[0]->getLocation();
point = holesClipper->convertToNodeSpace(point);
//[2].獲取底板區域矩形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].觸摸點在底板內部, 進行"打洞"
if (rect.containsPoint(point))
{
pokeHoleAtPoint(point);
}
}
//
1.5、實現“打洞”操作函數
//
void HelloWorld::pokeHoleAtPoint(Vec2 point)
{
CCLOG("Add a Hole!!!");
//[1].添加底板內容 : 一個洞的痕跡
auto hole = Sprite::create("hole_effect.png");
hole->setPosition(point);
holes->addChild(hole);
//[2].添加模板內容 : 一個小洞
auto holeStencil = Sprite::create("hole_stencil.png");
holeStencil->setPosition(point);
holesStencil->addChild(holeStencil);
//[3].動作效果 : 放大縮小
holesClipper->runAction(Sequence::create(ScaleTo::create(0.05f, 1.05f), ScaleTo::create(0.05f, 1.0f), NULL));
}
//
1.6、分析與總結
這裏設置了倒置顯示(Inverted),即使用模板對底板進行裁剪後,顯示未被剪下的剩餘部分。
(1)模板Stencil:
(2)底板:
(3)裁剪遮罩效果圖:
顯示未被模板裁剪的剩餘部分。
2、“文字遮罩特效”
先來看看效果:
2.1、素材
2.2、代碼實現
//
//[1].背景圖片
Sprite* bg = Sprite::create("HelloWorld.png");
bg->setPosition(visibleSize / 2);
this->addChild(bg, -1);
//[2].創建主題文字 : gameTitle
Sprite* gameTitle = Sprite::create("game_title.png");
//獲取尺寸大小
Size clipSize = gameTitle->getContentSize();
//[3].創建底板的發光圖片 : spark
Sprite* spark = Sprite::create("spark.png");
spark->setPosition(-clipSize.width, 0);
//[4].創建裁剪節點 : clippingNode
ClippingNode* clippingNode = ClippingNode::create();
clippingNode->setPosition(visibleSize / 2);
this->addChild(clippingNode);
clippingNode->setAlphaThreshold(0.05f); //設置alpha閘值
clippingNode->setContentSize(clipSize); //設置尺寸大小
clippingNode->setStencil(gameTitle); //設置模板stencil
clippingNode->addChild(gameTitle, 1); //先添加標題,會完全顯示出來,因爲跟模板一樣大小
clippingNode->addChild(spark,2); //會被裁減
//[5].左右移動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、分析與總結
實際上就是將文字作爲模板Stencil,做出文字的“形狀模板”,然後去裁剪底板。
而底板則是由文字、發光棒組合而成,然後移動發光棒,就可以呈現文字發光的效果。
(1)模板Stencil:
(2)底板:
(3)剪裁遮罩效果圖: