uSequencer 准确显示瞬时事件和持续事件

uSequencer 准确显示瞬时事件和持续事件

这是侑虎科技第97篇原创文章,感谢作者唐建伟(网名:焱燚,简称七火,QQ:383684387)供稿。欢迎转发分享,未经作者授权请勿转载。作者博客:http://www.seven-fire.cn/。如果您有任何独到的见解或者发现也欢迎联系我们,一起探讨。(QQ群465082844)

同时,作者也是U Sparkle活动参与者哦,UWA欢迎更多开发朋友加入 U Sparkle开发者计划,这个舞台有你更精彩!


这是uSequencer系列的第二篇,距离上一篇:uSequencer初识 已经一个月了。在上一篇博文中,我们简单介绍了uSequencer的一些基本功能和特性,同时也说到了uSequencer的一些不足之处:一些边角的东西做得不是特别好。不过好在修改这些小功能都是很简单很方便的,毕竟有uSequencer强大的结构支撑着,任何小修改和优化都是那样的简单和实用。

在上一篇中有提到过uSequencer的事件几乎是一个万能的东西,只要你需要,没有用它完成不了的。这篇文章先介绍下解决瞬时和持续事件的显示方式,让它准确地传达出每个事件的真实意图。


准确显示瞬时和持续事件

为了方便我们测试,我创建了两个事件,分别是一个瞬时事件和一个持续事件,里面不包含任何的逻辑,只是用它来测试默认情况下的事件显示问题,具体的创建可以参考官方文档:
https://www.wellfired.com/usequencer.html

代码如下:

[USequencerFriendlyName("瞬时事件")]
[USequencerEvent("Custom/Instant Event 瞬时事件")]
[USequencerEventHideDuration()]
public class SFInstantEvent : USEventBase {
    public override void FireEvent() {

    }

    public override void ProcessEvent(float runningTime) {

    }
}

[USequencerFriendlyName("持续事件")]
[USequencerEvent("Custom/Continue Event 持续事件")]
public class SFContinueEvent : USEventBase {
    public override void FireEvent() {

    }

    public override void ProcessEvent(float runningTime) {

    }
}

这两个事件在编辑面板下的显示如下:
0.png

在事件展开模式下,这个两个事件的显示长度一样,如果不是上面的文字,根本区分不出这两个事件哪个是瞬时事件,哪个是持续事件。
请输入图片描述

在事件折叠模式下,这两个事件又都统一的显示为一个小竖条,真的是傻傻分不清楚。

这样的一种显示模式,通常会误导美术,难以区分瞬时和持续事件,编辑时多多少少会受影响。下面我们就来看看怎么修正这个问题,让uSequencer准确显示瞬时事件和持续事件。

一、展开模式Expand

1.1 修改所有事件的默认长度
通过分析uSequencer的源码,发现每个事件的默认显示模式都由USEventBaseEditor.cs这个脚本来控制,通过修改里面的方法DrawEventInTimeline可以修改每个事件的默认长度,修改代码如下:

USEventBaseEditor:
请输入图片描述

修改后的显示结果:
请输入图片描述
事件已经如我们的预期的方式显示了:瞬时事件为一个竖条,持续事件为一个矩形区域。同时也发现瞬时事件的标签没有显示出来,我们继续探索研究。

1.2 修改该模式下的默认标签长度
在上一个方法的结束位置,调用了RenderEvent来具体的绘制每个事件,在RenderEvent这个方法里负责具体绘制事件的背景区块和相应的标签。在默认情况下标签的显示区域就是上面给的renderingArea,瞬时事件瞬间就尴尬了。

没事,我们来修改相应的代码,把背景区块的Area与标签的Area区分开,标签的区域允许超过背景块的区域,不然持续时间很短的持续时间的标签也会显示不完整(提示只能看到一半,很让人抓狂,不做吊胃口的事)。具体的修改如下所示。

USEventBaseEditor:
请输入图片描述

修改后的显示结果:
请输入图片描述

原先的持续事件标签超过背景区域:
请输入图片描述

修改后的显示:
请输入图片描述
通过以上修改,其实也就7行代码,就可以让瞬时事件和持续事件在Expand模式下一眼区分开,何乐而不为呢!

二、折叠模式Hide

修改完展开模式下的显示,是不是折叠模式下也能正常显示了呢?现实有点残酷,然而并不如我们想的那样:瞬时和持续事件还是只是一个小竖条,如下所示:
请输入图片描述

2.1 修改默认的宽度和计算持续事件的宽度
依然还是在 USEventBaseEditor.cs这个脚本里面,通过分析和测试,折叠模式下的显示走的是另外一个方法DrawCollapsedEventInTimeline来绘制折叠模式下的事件,通过对比展开模式(DrawEventInTimeline)的相关逻辑,做出了如下的修改:

USEventBaseEditor:
请输入图片描述

默认宽度还是4,如果是持续事件的话,重新计算宽度。修改后的显示结果如下:
请输入图片描述

已经能准确的显示瞬时事件和持续事件,但是你以为这样就结束了吗?然而并没有,你会发现这样的修改后,鼠标在点选持续事件的时候,很难点中,只有点击持续事件开始的那小块区域才能选中事件,这不是坑爹么?使用起来多么不方便,我们继续修改。请继续往下看~~~

2.2 修改折叠模式下的点选准确性
在上面的问题中其实就已经暗含了造成持续事件点选不中的根本原因:事件命中区域与显示区域的不一样。而在展开模式下完全没有这个问题,通过对比USEventBaseEditor.cs下的DrawEventInTimeline与DrawCollapsedEventInTimeline方法可以发现一些奇妙和不一样的地方。当然还有同一个脚本里的RenderEvent与RenderCollapsedEvent,以及EventEditor.cs下的OnGUI和OnCollapsedGUI。

对,折叠模式下的这两个方法没有返回值,而这个返回值确实决定了每个事件的点选区域。我对它的修改的内容如下:

USEventBaseEditor:
请输入图片描述

USEventBaseEditor:
请输入图片描述

EventEditor:
请输入图片描述

修改后的显示和点选结果,已经能够正常点选了:
请输入图片描述

三、持续事件的默认时间

上面的方法已经解决了瞬时和持续事件的准确显示问题,但当我们新建持续事件时,默认持续时间竟然是-1s。
请输入图片描述
这~~~这不科学,虽然瞬时事件其实就是一个持续时间为-1s的事件,但是你也不能把持续事件的默认时间也设置为-1s呀,不然我们上面的修改会把这个持续事件默认显示为一个一个小竖条的瞬时事件,这岂不是又在误导美术么,没办法就继续修改吧,谁叫咱们有源码。

跟踪和分析了下源码,定位在创建事件的时候,我们只要在创建的时候区分开瞬时事件和持续事件,把持续事件的持续时间设置为一个默认的持续时间(不要小于0就可以了),我们的修改如下所示:

EventEditor:
请输入图片描述

代码:

var customAttributes = type.GetCustomAttributes(true).Where(attr => attr is USequencerEventHideDurationAttribute).Cast<USequencerEventHideDurationAttribute>().ToArray();
if (customAttributes.Length == 0)
    eventComponent.Duration = 1;

界面显示如下:
请输入图片描述

以上就可以让uSequencer准确的创建和显示我们的瞬时和持续事件。细心的朋友是否已经发现,通过我们的修改USEventBaseEditor.cs下的DrawEventInTimeline与DrawCollapsedEventInTimeline和RenderEvent与RenderCollapsedEvent,以及EventEditor.cs下的OnGUI和OnCollapsedGUI它们之间已经没有太多差距,可以对它们进行合并,简化逻辑,这里就不详细介绍了。

还有时间,塞几个小修改,废话不多说,都在代码里:

1.折叠模式下的宽度
请输入图片描述
EventEditor:
请输入图片描述

USEventTimelineHierarchyItem:
请输入图片描述
请输入图片描述

2.修改字体大小
请输入图片描述
路径:Assets/WellFired/usequencer/Uncompiled/Editor/Resources/uSequencerProSkin.guiskin
请输入图片描述
请输入图片描述
请输入图片描述

文末,再次感谢唐建伟的分享,如果您有任何独到的见解或者发现也欢迎联系我们,一起探讨。(QQ群465082844)。
也欢迎大家来积极参与U Sparkle开发者计划,简称"US",代表你和我,代表UWA和开发者在一起!