在 Unity 中使用 FairyGUI GList 制作 Sp
项目中使用 FairyGUI 作为 UI 编辑器。在 Glist virtualList 中挂载 Spine 时,遇到了一些问题。经过历时1周的排查处理后,终于可以正常交付了。现将出现的问题、思考和解决方案记录下来。
回收 Spine
项目的底层基于 GameFramework(后面简称 GF)。因为游戏的整个生命周期内,需要创建和释放的Spine 数量巨大,因此采用了 GF 中 ObjectPool 来管理实例对象,减少游戏的 GC,提高游戏的流畅度。
当 Spine 用在 Glist virtualList 中时,GList 的 item 回收的同时,也要回收 Spine 。在查看了 GList 的源码后,没有找到合适的接口来处理这一逻辑。于是自己在 Glist 中加入了一个释放资源的委托。
主要部分如下:
......
/// <summary>
/// Callback function when an item is needed to clear its look.
/// </summary>
/// <param name="item">Item object.</param>
public delegate void ListItemClear(GObject item);
/// <summary>
/// Callback function when an item is needed to clear its look.
/// </summary>
public ListItemClear itemClear;
......
public override void Dispose()
{
_pool.Clear();
if (_virtualListChanged != 0)
Timers.inst.Remove(this.RefreshVirtualList);
_selectionController = null;
scrollItemToViewOnClick = false;
itemRenderer = null;
itemProvider = null;
itemClear = null;
base.Dispose();
}
........
void ReturnToPool(GObject obj)
{
itemClear?.Invoke(obj);
_pool.ReturnObject(obj);
}
......
这样,在使用时,给 itemClear 增加委托函数,在其中处理 Spine 的回收,问题得到了解决。
GList 对 Spine 的裁剪修改了 sharedMaterial
众所周知,Spine 的所有实例,一般情况下使用的是公共的材质。也就是说,针对单个实例的材质的修改,会影响所有实例的材质。
因此,当从UI退出后,场景中的Spine也被添加了裁剪而无法显示。
处理这一过程,经历了三个阶段:
去掉 sharedMaterial 中的裁剪
这种方式的思路比较简单,就是在 Spine 回收时,重置 sharedMaterial 的设置。
具体方法,是在回收spine的逻辑中,添加如下语句:
spineGameObject.GetComponent<MeshRenderer>().sharedMaterial.DisableKeyword("CLIPPED");
效果也是立竿见影的,关闭UI回到场景后,Spine 可以正常显示。
但马上,新的问题出现了,就是当UI不是全屏时,UI 和 场景中的 Spine 会同时出现。这时,场景中的 Spine 还是无法正常显示。
这种情况下,就需要新的思路。很快,FairyGUI 支持 clone 材质的接口出现在了眼前。
Clone Material
这里需要补充一个知识点,将 Spine 显示在 FairyGUI 的界面中,需要 GGraph 作为占位元素,之后创建 GoWrapper 来填充这个占位元素,并将 Spine 实例作为 GoWrapper 的 target。
GoWrapper 提供了 clone material 的方法:
var goWrapper = new GoWrapper();
goWrapper.SetWrapTarget(spineGameObject, true);
gGraph.SetNativeObject(goWrapper);
这里,SetWrapTarget 的第二个参数,就代表是否 clone material。
此外,还要将 clone 的材质,应用到 Spine 的实例上:
var spineAnimation = spineGameObject.GetComponent<SkeletonAnimation>();
goWrapper.customCloneMaterials = (materials) => {
foreach (var kv in materials)
{
spineAnimation.CustomMaterialOverride[kv.Key] = kv.Value;
}
};
同时,在 Spine 回收时,要记得清除掉 clone material 对这个 Spine 实例的影响:
spineAnimation.CustomMaterialOverride.Clear();
这样,当 UI 和场景中的 Spine 同时出现时,由于UI的Spine只针对clone的材质使用了裁剪,因此场景中的Spine也能够正常显示。
本以为至此便可以功德圆满,但当拖动 GList 时,发现在GList两端的Spine Item 要进入可视区域时,Spine 会有一瞬间,不受裁剪的影响而出现在可视区域以外,但很快又恢复正常。
经过仔细的检查,发现在 clone material 生效前,Spine 已经开始了绘制,这时所有的材质上都没有添加裁剪,所以出现了上面描述到的问题。
查找了大量的资料,也没有找到合适的解决方法。那还是回到问题本身,既然是 clone material 和 Spine 开始绘制之间有延迟,那么可以等这个延迟过后,再显示 Spine。
延迟显示 Spine
在 Spine 加载成功后,先将缩放设置为0,在固定数量的帧数后,再将缩放值恢复:
goWrapper.scale = Vector2.zero;
goWrapper.onUpdate += OnUpdate;
帧更新函数如下:
/// <summary>
/// 帧计数
/// </summary>
private int frameCount = 0;
/// <summary>
/// SpineWrapper的更新函数
/// </summary>
/// <param name="context">更新上下文</param>
private void OnUpdate(UpdateContext context)
{
if (frameCount >= delayFrameCount)
{
frameCount = 0;
goWrapper.scale = Vector2.one;
goWrapper.onUpdate -= OnUpdate;
return;
}
frameCount++;
}
经过测试,delayFrameCount 值是1。可以根据项目的实际情况调整该值的大小。需要注意的是,当值过大时,UI界面打开与spine出现的时间间隔会更明显,影响体验。
以上就是这次实现在 Unity 中使用 FairyGUI GList 制作 Spine 列表的全过程。
如果有更好的方法,欢迎评论区留言讨论。