【Cocos2d-x 3.2】裁剪节点（ClippingNode）总结

本文出自 “夏天的风”
博客，请务必保留此出处/article/4603082.html

有时候我们需要显示一张图片的部分区域，比如文字遮罩、图片遮罩等。





本节要讲的ClippingNode的功能效果大致就是上面所看到的遮罩效果。

Demo下载：

裁剪节点ClippingNode.rar

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的Cocos2d-x背景图片。







裁剪遮罩效果示意图：



2.3、分析总结

通过ClippingNode进行裁剪遮罩，其实是这样的：

将模板（Stencil）上所有元素的形状集合作为“形状模板”，其元素本身不渲染。

使用“形状模板”对底板进行裁剪。

显示从底板上裁剪下来的图片区域。

总的来说：

模板（Stencil）相当于是一个样板，上面有很多不同形状的"洞洞"。

然后根据样板，对底板进行裁剪，"挖洞"。

然后将剪下来的那些碎片，按照原来的位置进行摆放。

其中：模板（Stencil）只是一个“形状模板”，本身的图片是不进行绘制的。

3、主要函数

ClippingNode继承于Node类，用于节点的裁剪与遮罩。

3.1、创建ClippingNode

两种方式：是否使用模板（stencil）来创建。

3.2、设置模板（Stencil）

模板节点是Node的子类，一般常常使用DrawNode，因为它可以绘制不同形状的图形。当然也可以直接使用Node节点作为作为模板。

3.3、设置底板（Content）

3.4、倒置显示（Inverted）

false ：显示被模板裁剪下来的底板内容。默认为false。

true ：显示剩余部分。

3.5、alpha阈值（alphaThreshold）

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

只有模板（stencil）中像素的alpha值大于alpha阈值时，内容才会被绘制。

alpha阈值（alphaThreshold）：取值范围[0,1]。

默认为1，表示alpha测试默认关闭，即全部绘制。

若不是1，表示只绘制模板中，alpha像素大于alphaThreshold的内容。

具体说明：

以下是一张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中添加如下变量与函数

1.3、在HelloWorld.cpp中的init()中创建裁剪节点ClippingNode

1.4、设置触摸事件回调。当触摸点在底板区域内部，则“打洞”

1.5、实现“打洞”操作函数

1.6、分析与总结

这里设置了倒置显示（Inverted），即使用模板对底板进行裁剪后，显示未被剪下的剩余部分。

（1）模板Stencil：



（2）底板：



（3）裁剪遮罩效果图：显示未被模板裁剪的剩余部分。



2、“文字遮罩特效”

先来看看效果：





2.1、素材







2.2、代码实现

2.3、分析与总结

实际上就是将文字作为模板Stencil，做出文字的“形状模板”，然后去裁剪底板。而底板则是由文字、发光棒组合而成，然后移动发光棒，就可以呈现文字发光的效果。

（1）模板Stencil：



（2）底板：



（3）剪裁遮罩效果图：