【UE5】UMG C++父类绑定蓝图子类属性

有时我们在设计UMG时可能会使用到C++父类来处理一些通用逻辑，如果我们想要在C++父类中获取其派生子类的某个属性，如Image或Button等，我们可以通过使用UE提供的BindWidget元数据标签的方式来获取。

BindWidget

BindWidget元数据标签在官方文档中并没有出现，但引擎是支持这个标签的。

在看例子之前我们需要注意一些BindWidget的要求：

• BindWidget标识的变量必须是public变量；
• BindWidget标识的变量必须是UWidget类型及其派生类型；
• BindWidget标识的变量必须是指针；
• 蓝图子类中必须存在同类型的同名控件。

首先我们创建一个继承自UUserWidget的自定义C++类UCusWidget，然后创建一个public变量，然后在UPROPERTY中设置BindWidget元数据：

UCLASS()
class MYPROJECT_API UCusWidget : public UUserWidget
{
	GENERATED_BODY()
public:
	UPROPERTY(BlueprintReadWrite, Meta = (BindWidget),Category = "CusWidget")
	UImage* CusImage;
	UPROPERTY(BlueprintReadWrite, Meta = (BindWidget),Category = "CusWidget")
	UTextBlock* CusText;

	virtual void NativeConstruct() override;
};

然后创建一个继承自UCusWidget的UMG蓝图UW_Cus，为UI添加一个Image并命名为CusImage，添加一个TextBlock并命名为CusText：

这样控件CusImage和CusText就和父类中的同名变量绑定了，如此父类便可以通过同名变量来控制子类的控件了。

这里我们在Widget构造时给与CusImage一个随机颜色并在CusText中显示颜色的RGBA值：

void UCusWidget::NativeConstruct()
{
	Super::NativeConstruct();
	if(CusImage)
	{
		CusImage->SetColorAndOpacity(FLinearColor::MakeRandomColor());
	}
	if(CusText)
	{
		CusText->SetText(FText::FromString(CusImage->ColorAndOpacity.ToString()));
	}
}

然后就可以看到结果了：

这里我在另一个Widget中封装了多个UW_Cus以便观察。

这里有一个坑需要注意，更新控件属性时应该使用对应的Set函数，如：CusImage->SetColorAndOpacity(FLinearColor::MakeRandomColor())，而不是直接赋值，如：CusImage->ColorAndOpacity = FLinearColor::MakeRandomColor()，直接赋值Widget不会更新样式。

BindWidgetOptional

BindWidget元数据需要强制绑定子蓝图的同名控件，而BindWidgetOptional功能上和BindWidget一致，但不需要强制绑定子蓝图中的同名控件，所以这就要求在书写C++代码时需要更严谨，因为它们修饰的变量都是指针，而使用BindWidgetOptional极容易出现空指针。

BindWidgetAnim

BindWidgetAnim是专门用来绑定UWidgetAnimation类型变量的元数据，和BindWidget一样，BindWidgetAnim对变量也有要求：

• BindWidgetAnim标识的变量必须是public变量；
• BindWidgetAnim标识的变量必须是UWidgetAnimation类型及其派生类型；
• BindWidgetAnim标识的变量必须是指针；
• BindWidgetAnim标识的变量必须是Transient变量；
• 蓝图子类中必须存在同名的Widget动画。

关于Transient，Transient也是一个UPROPERTY的标识符，用于标识变量是否是临时变量，被标识的变量会被禁止序列化，如：

UCLASS()
class MYPROJECT_API UCusWidget : public UUserWidget
{
	GENERATED_BODY()
public:
	UPROPERTY(BlueprintReadWrite, Meta = (BindWidgetOptional),Category = "CusWidget")
	UImage* CusImage;
	UPROPERTY(BlueprintReadWrite, Meta = (BindWidgetOptional),Category = "CusWidget")
	UTextBlock* CusText;
	UPROPERTY(BlueprintReadWrite,Transient, Meta = (BindWidgetAnim),Category = "CusWidget")
	UWidgetAnimation* StartAnime;

	virtual void NativeConstruct() override;	
};

BindWidgetAnimOptional

BindWidgetAnimOptional功能和BindWidgetOptional一样，用于非强制绑定动画的情况；

UE元数据参考

https://benui.ca/unreal/uproperty/#umg