UGUI源码解析（Toggle和ToggleGroup）

Runtime类图分析

 

Toggle

Toggle继承了Selectable, IPointerClickHandler, ISubmitHandler, ICanvasElement，(ICanvasElement，是Canvas渲染的时候调用的接口)

 

关键方法

OnEnable时将自己注册到ToggleGroup并调用PlayEffect。OnDisable时将自己移出ToggleGroup

 

重写OnDidApplyAnimationProperties，判断m_IsOn是否被动画改变（判断图像的Alpha是否接近零）

 

SetToggleGroup(ToggleGroup newGroup, bool setMemberValue)，首先判断当前Toggle的旧的m_Group是否为空，如果不为空那么从中移除掉，如果setMemberValue为true，那么将newGroup的值设置给m_Group缓存起来，再调用newGroup的RegisterToggle方法，将当前的Toggle注册进去，在newGroup值不为空且当前的toggle是显示的状态下且isOn为true，那么调用newGroup的NotifyToggleOn(this)，通知当前的toggle是出于选中态

 

SetIsOnWithoutNotify(bool value)

通过传入变量value的值，调用Set方法，但是不发送事件

 

Set方法用于设置m_IsOn的值，并发送事件onValueChanged.Invoke(m_IsOn)。除此之外，Set方法还会调用m_Group.NotifyToggleOn(this)。调用PlayEffect方法来播放切换效果。

 

PlayEffect，调用graphic.CrossFadeAlpha（根据状态改变/渐变图像的透明度）。

 

Toggle重写了Start方法，在Start的时候，PlayEffect。

 

InternalToggle，在未隐藏且可交互的条件下，反转isOn 

 

OnPointerClick和OnSubmit会调用InternalToggle方法切换Toggle的状态isOn = !isOn，isOn是Toggle的成员属性，它的set访问器会调用Toggle的Set成员方法。

 

重要属性和字段

m_IsOn

表示是否被勾选

UnityEvent<bool>类型的事件onValueChanged

用于外部监听m_IsOn是否改变

 

ToggleGroup

ToggleGroup继承自UIBehaviour，可以将多个Toggle分到一个组里而保持至多一个Toggle状态为On。维护了一个ToggleList，用于保存注册在该ToggleGroup的所有Toggle。

 

关键方法

Toggle在OnEnable的时候注册到group，OnDisable的时候移出group，另外通过为group属性赋值也可以让Toggle注册到指定的ToggleGroup。

NotifyToggleOn这个方法是将除了输入的Toggle之外所有的Toggle都关闭（isOn = false）。我们也可以调用ToggleGroup的一些方法，例如AnyTogglesOn判断是否有Toggle开启（Toggle的set方法也调用了这个方法，即没有任何Toggle开启且group不允许全部Toggle关闭的时候，强制设为开启），ActiveToggles获取开启的Toggle，SetAllTogglesOff关闭所有Toggle。

 

UnregisterToggle

从toggle的列表中移除指定的toggle，判断在!allowSwitchOff && !AnyTogglesOn() && m_Toggles.Count != 0，将第一个toggle设置为选中状态

 

RegisterToggle

往toggle的列表中添加指定的toggle，判断在!allowSwitchOff && !AnyTogglesOn()的条件下将当前这个toggle设置为选中状态，同时调用NotifyToggleOn通知其他的toggle

 

AnyTogglesOn

判断toggle Group中的toggle列表中是否有任何一个toggle的isOn为true

 

ActiveToggles

返回获取toggle Group中的toggle列表中的第一个isOn为true的toggle

 

SetAllTogglesOff(bool sendCallback = true)

设置所有toggle的isOn为false，如果sendCallback 为true，需要发送当前toggle值改变的事件

 

重要属性和字段

m_AllowSwitchOff

是否允许有的toggle处于未选中状态，如果不勾选，那么当前的toggle Group中必须得有一个toggle处于选中状态

private List<Toggle> m_Toggles = new List<Toggle>()

当前toggle Group组下的toggle列表