Version: 6000.3
语言: 中文
定义绑定模式和更新触发器
定义日志记录级别

转换数据类型

可以使用类型转换器在数据源和 UI 之间转换数据类型。这使您能够:

  • 绑定与 UI 不同的数据类型,例如绑定到Texture2D属性来自int价值。
  • 当需要不同的数据表示形式时,转换与 UI 相同的数据类型,例如以度而不是弧度为单位显示角度。

类型转换器有两类:全局转换器和按绑定转换器。

全球转换器

全局转换器是静态注册的,并且可用于所有绑定实例,无论绑定模式如何。为方便起见,绑定系统提供了多个预注册的全局转换器,例如样式值与其基础数据表示之间的转换器。您可以使用它们绑定常规floatStyleKeyword设置为StyleFloat属性,而不是使用StyleFloat在数据源中。

要注册全局转换器,请使用ConverterGroups.RegisterGlobalConverter方法。此方法需要委托将源类型转换为目标类型。委托必须是refdelegate 以启用双向使用。注册后,全局转换器会自动应用于需要该特定类型转换的任何绑定实例,无需任何额外配置。

以下示例注册一个全局转换器,该转换器在Texture2DTextureHandle:

public struct TextureHandle
{
    public static Texture2D ResolveTexture(TextureHandle handle)
    {
        return /* Actual texture */; 
    } 
    
   public static TextureHandle FromTexture(Texture2D texture)
   {
        return new TextureHandle { handle = /* Compute handle */ }; 
   }

    public int handle;
}

// Registers the global converter
ConverterGroups.RegisterGlobalConverter((ref TextureHandle handle) => TextureHandle.ResolveTexture(handle));
ConverterGroups.RegisterGlobalConverter((ref Texture2D texture) => TextureHandle.FromTexture(texture));

每个绑定转换器

每个绑定转换器适用于特定的绑定实例。您可以注册单个或一组每个绑定的转换器。

单个转换器

要注册单个转换器,请使用DataBinding.sourceToUiConverters.AddConverterDataBinding.uiToSourceConverters.AddConverter方法。这些方法需要委托将源类型转换为目标类型。委托必须是refdelegate 以启用双向使用。

以下示例注册并应用各个转换器,以在绑定实例的弧度和度数之间进行转换:

var binding = new DataBinding();
binding.sourceToUiConverters.AddConverter((ref float radian) => Mathf.RadToDeg * radian);
binding.uiToSourceConverters.AddConverter((ref float degree) => Mathf.DegToRad * degree);

组转换器

要注册一组转换器并将它们应用于DataBinding实例,请使用ConverterGroup类。

以下示例显示如何注册一组转换器:

// Create a converter group
var group = new ConverterGroup("Inverters");

// Add converters to the converter group
group.AddConverter((ref int v) => -v);
group.AddConverter((ref float v) => -v);
group.AddConverter((ref double v) => -v);
// Register the converter group
ConverterGroups.RegisterConverterGroup(group);


// Add a converter to an existing converter group
if (ConverterGroups.TryGetConverterGroup("Inverters", out var group))
{
    group.AddConverter((ref short v) => -v);
}

应用转换器组

注册转换器组后,可以将其应用于绑定实例。你可以将转换器组应用于C#、UI Builder或UXML中的绑定实例。

若要在 C# 中应用转换器组,请使用DataBinding.ApplyConverterGroupToUIDataBinding.ApplyConverterGroupToSource方法。这些方法将转换器组名称作为参数。

以下示例应用转换器组Inverters到 C# 中的绑定实例:

var binding = new DataBinding();
if (ConverterGroups.TryGetConverterGroup("Inverters", out var group))
{
    binding.ApplyConverterGroupToUI(group);
    binding.ApplyConverterGroupToSource(group);
}

注意:当您将转换器组应用到另一个转换器组时,它会以“一劳永逸”的方式运行。这意味着,当您应用转换器组时,它会独立执行其预期功能,而无需您进行额外的持续监控或管理。

以下示例应用转换器组Inverters到 UXML 中的绑定:

<ui:DataBinding source-to-ui-converters="Inverters" ui-to-source-converters="Inverters" />

有关如何在 UI Builder 中应用转换器组的详细信息,请参阅运行时绑定入门

最佳做法

请遵循以下提示和最佳实践来优化性能:

  • 尽量减少内存分配:尽可能避免编写分配内存的转换委托,尤其是在处理enum类型。在转换期间分配内存可能会引入不必要的开销并影响性能。相反,选择高效且内存友好的转换方法。
  • 保持转换器效率:让转换器专注于执行快速高效的类型转换非常重要。避免在转换器内执行大量任务或复杂作,因为这可能会导致性能下降并可能引入不必要的复杂性。
  • 数据源中集成类型转换:不要仅仅依赖按绑定的转换,而是考虑将类型转换直接合并到数据源中。通过在数据源本身内处理转换,您可以简化流程并有可能提高整体性能。这种方法还可以降低与按绑定管理转化相关的复杂性。

已知限制

源类型和目标类型必须完全匹配,除非它们的类型为UnityEngine.Object.例如,您无法将int设置为floatfloat设置为int.这可能会很不方便,尤其是在enum类型。此限制将在将来的版本中得到解决。

其他资源

定义绑定模式和更新触发器
定义日志记录级别