Slate 相关宏以及 TAttribute

2022-10-25
5分钟阅读时长
Slate

UE5版本:5.03

举个例子

class SMyWidget : public SCompoundWidget
{
    SLATE_BEGIN_ARGS( SMyWidget )
         , _PreferredWidth( 150.0f )
         , _ForegroundColor( FLinearColor::White )
         {}
		SLATE_ARGUMENT(FString, Directory)
        SLATE_ATTRIBUTE(float, PreferredWidth)
        SLATE_ATTRIBUTE(FSlateColor, ForegroundColor)
    SLATE_END_ARGS()

	// ... ... 
}

SLATE_BEGIN/END_ARGS

SLATE_BEGIN_ARGS() 和 SLATE_END_ARGS() 的意义在引擎源码中已经写了：让用户可以通过 SNew 和 SAssignNew 来构建 Slate。但这只是个概述，除此之外的很多细节，我们本文中一一探究。

因为 SLATE_END_ARGS() 宏仅仅只是一个结束大括号和分号，所以我们将 SLATE_BEGIN_ARGS() 宏和它一起展开，得到：

class SMyWidget : public SCompoundWidget
{
public: 
	struct FArguments : public TSlateBaseNamedArgs<SMyWidget> 
	{ 
		typedef FArguments WidgetArgsType; 

		// FArguments的构造函数
		FORCENOINLINE FArguments()
			, _PreferredWidth( 150.0f )
			, _ForegroundColor( FLinearColor::White )
         	{}
		//ARGUMENT 和 ATTRIBUTE 的部分，暂时先不展开
		SLATE_ARGUMENT(FString, Directory)
		SLATE_ATTRIBUTE(float, PreferredWidth)
        SLATE_ATTRIBUTE(FSlateColor, ForegroundColor)
	};
	// ...
}

SLATE_BEGIN_ARGS 声明了一个 FArguments 结构体，并定义了构造函数。

FArguments 派生自 TSlateBaseNamedArgs。

TSlateBaseNamedArgs 及其父类 FSlateBaseNamedArgs 中包含一组由 SLATE_PRIVATE_ATTRIBUTE_VARIABLE 和 SLATE_PRIVATE_ATTRIBUTE_FUNCTION 定义的 TAttribute 以及函数，比如 ToolTip, Cursor, Visibility, IsEnabled 等，这是每个Slate都具有的共有属性。

SLATE_ARGUMENT

SLATE_ARGUMENT 是一个“静态的属性”，它的宏也很简单，我们可以直接将它全部展开。

SLATE_ARGUMENT(FString, MyVar)
// 第一次展开后为：
SLATE_PRIVATE_ARGUMENT_VARIABLE( FString, MyVar ); 
SLATE_PRIVATE_ARGUMENT_FUNCTION ( FString, MyVar )
// 完全展开后为：
FString _MyVar;
WidgetArgsType& MyVar( FString InArg ) 
{ 
	_MyVar = InArg; 
	return this->Me(); 
}

可以看到 SLATE_ARGUMENT 定义的生成了一个前面带下划线的变量，类型为指定的类型。由此可知我们只能在父对象中构造该Slate时直接对 SLATE_ARGUMENT 进行一次性的赋值，不能进行绑定，也不能在Slate中获取或者修改他的值。

SLATE_ATTRIBUTE宏

SLATE_ATTRIBUTE 宏是Slate中用来给一个Slate界面添加属性的，这个属性可以在构建这个Slate的时候从父级传入。

SLAET_ATTRIBUTE宏只能出现在 SLATE_BEGIN_ARGS 宏和 SLATE_END_ARGS 宏之间。

它的语法是: SLATE_ATTRIBUTE(数据类型，属性名称)

它会生成这样一个变量： TAttribute<数据类型> _属性名称 ， 注意属性名称前面添加了一个下划线。

另外它还包含一些可以给自身绑定 Getter 方法的函数。

SLATE_ATTRIBUTE的主要作用就是开放参数给构造该Slate的父级代码，在父级可以传入参数，也可以在父级直接绑定一个函数作为Getter。

展开SLATE_ATTRIBUTE宏

任意带入两个参数，对 SLATE_ATTRIBUTE 进行宏展开，例如这里带入 FString 和 MyVar。

第一次展开

第一次展开 SLATE_ATTRIBUTE 宏可以得到：

#define SLATE_ATTRIBUTE( FString, MyVar ) 
		SLATE_PRIVATE_ATTRIBUTE_VARIABLE( FString, MyVar ); 
		SLATE_PRIVATE_ATTRIBUTE_FUNCTION( FString, MyVar )

可以看到分两部分，第一部分是变量，第二部分是函数。

这里用到的两个宏和前面 TSlateBaseNamedArgs 中使用的是一样的。

展开变量部分

//#define SLATE_PRIVATE_ATTRIBUTE_VARIABLE( FString, MyVar )
		TAttribute<FString> _MyVar;

变量部分比较简单，正如前文所述，生成了一个 TAttribute，并且变量名称前面增加了一个下划线。后文再分析TAttribute。

展开函数部分

#define SLATE_PRIVATE_ATTRIBUTE_FUNCTION( FString, MyVar ) 
		WidgetArgsType& MyVar( TAttribute< FString > InAttribute ) 
		{ 
			MyVar = MoveTemp(InAttribute); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		} 
		
		/* Bind attribute with delegate to a global function
		 * NOTE: We use a template here to avoid 'typename' issues when hosting attributes inside templated classes */ 
		template< typename... VarTypes >
		WidgetArgsType& MyVar_Static( typename TAttribute< FString >::FGetter::template FStaticDelegate<VarTypes...>::FFuncPtr InFunc, VarTypes... Vars )
		{ 
			_MyVar = TAttribute< FString >::Create( TAttribute< FString >::FGetter::CreateStatic( InFunc, Vars... ) ); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		} 

		/* Bind attribute with delegate to a lambda
		 * technically this works for any functor types, but lambdas are the primary use case */ 
		WidgetArgsType& MyVar_Lambda(TFunction< FString(void) >&& InFunctor) 
		{ 
			_MyVar = TAttribute< FString >::Create(Forward<TFunction< FString(void) >>(InFunctor)); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		} 
		
		/* Bind attribute with delegate to a raw C++ class method */ 
		template< class UserClass, typename... VarTypes >	
		WidgetArgsType& MyVar_Raw( UserClass* InUserObject, typename TAttribute< FString >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc, VarTypes... Vars )	
		{ 
			_MyVar = TAttribute< FString >::Create( TAttribute< FString >::FGetter::CreateRaw( InUserObject, InFunc, Vars... ) ); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		} 
		
		/* Bind attribute with delegate to a shared pointer-based class method.  Slate mostly uses shared pointers so we use an overload for this type of binding. */ 
		template< class UserClass, typename... VarTypes >	
		WidgetArgsType& MyVar( TSharedRef< UserClass > InUserObjectRef, typename TAttribute< FString >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc, VarTypes... Vars )	
		{ 
			_MyVar = TAttribute< FString >::Create( TAttribute< FString >::FGetter::CreateSP( InUserObjectRef, InFunc, Vars... ) ); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		} 
		
		/* Bind attribute with delegate to a shared pointer-based class method.  Slate mostly uses shared pointers so we use an overload for this type of binding. */ 
		template< class UserClass, typename... VarTypes >	
		WidgetArgsType& MyVar( UserClass* InUserObject, typename TAttribute< FString >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc, VarTypes... Vars )	
		{ 
			_MyVar = TAttribute< FString >::Create( TAttribute< FString >::FGetter::CreateSP( InUserObject, InFunc, Vars... ) ); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		} 

		/* Bind attribute with delegate to a UObject-based class method */ 
		template< class UserClass, typename... VarTypes >	
		WidgetArgsType& MyVar_UObject( UserClass* InUserObject, typename TAttribute< FString >::FGetter::template TConstMethodPtr< UserClass, VarTypes... > InFunc, VarTypes... Vars )	
		{ 
			_MyVar = TAttribute< FString >::Create( TAttribute< FString >::FGetter::CreateUObject( InUserObject, InFunc, Vars... ) ); 
			return static_cast<WidgetArgsType*>(this)->Me(); 
		}

第一个函数接受一个TAttribute，不做任何绑定，其余函数可以接收可调用对象(Lambda, 原生C++类方法，基于共享指针的类方法，UObject的类方法)，将其传给TAttribute的相应的类静态函数Create(其实就是把这个函数设为Getter), 生成TAttribute, 并赋值给_MyVar。

也就是说，如果我们在给 SLATE_ATTRIBUTE 传值的时候只传入一个数值， 且在这个Slate定义的内部不再后续调用Bind操作， 那么这个 SLATE_ATTRIBUTE 就类似于一个 SLATE_ARGUMENT（除了它还可以使用Get来获取值，使用Set来设置值）。如果传入一个可调用对象， 那么就会给这个 TAttribute 绑定一个Getter。

TAttribute

查看 TAttribute 源码 (Attribute.h) 可以发现，它是一个模板类，接受一个ObjectType模板参数。

构造方法

无参构造函数构造一个空的对象， 没有任何东西被初始化。

可以直接用存储的数据类型的一个数据构造，初始化了数值，但是没有绑定Getter。

也可以传入函数，初始化 Getter 函数，但是数值并未初始化。

核心数据成员

它最核心的数据成员就是：

mutable ObjectType Value;

静态方法

该类有一些静态函数Create，他们接受各种类型的可调用对象(Lambda, 原生C++类方法，基于共享指针的类方法，UObject的类方法) 作为 Getter 函数，并返回一个TAttribute。有些类似于工厂函数。

成员方法

Set() 和 Get() 方法用于设置和获取数值

IsSet() 用于返回数值是否被设置

Bind(), BindStatic(), BindRaw(), BindUObject(), BindUFunction() 等用于绑定 Getter 函数

P.S. 注意Bind函数族只是绑定 Getter，并没有绑定 Setter，要设置值只能手动调用Set()。Getter保证了只要函数返回新的数值，会及时更新并显示到Slate中。

给SLATE_ATTRIBUTE传入参数/绑定函数的方法实例

例如 SButton有一个 .IsEnabled 的 SLATE_ATTRIBUTE (它虽然被分为了 SLATE_PRIVATE_ATTRIBUTE_FUNCTION 和 SLATE_PRIVATE_ATTRIBUTE_VARIABLE 两部分，但合起来就等同于一个 SLATE_ATTRIBUTE )，它控制着按钮的可见性。

静态值

如果该按钮的可见性在使用它的Slate构造时就直接确定了，我们可以直接给他一个确定的布尔值：

SNew(SButton)
.IsEnabled(true)

动态值

但是如果该按钮的可见性是动态决定的，我们就需要给他绑定一个Getter函数。

定义Getter函数

Getter函数必须是const类型的，且返回 Attribute 需要的数据类型。

例如我们可以这样定义这个getter函数：

// .h
bool ShouldShowCreateBtn() const;
// .cpp
bool SRadiationPanel::ShouldShowCreateBtn() const
{
	return HostRadiationComponent==nullptr;
}

接下来我们可以这样绑定Getter函数:

直接绑定一个Getter函数

SNew(SButton)
.IsEnabled(this, &SRadiationPanel::ShouldShowCreateBtn)

先声明、绑定，再使用

当然还有一种完全等价的方法： 先定义一个TAttribute类型的数据：

TAttribute<bool> bShowCreateBtn;

然后在当前Slate构造的时候进行绑定：

bShowCreateBtn.Bind(this, &SRadiationPanel::ShouldShowCreateBtn);

最后再使用这个 TAttribute 赋给 IsEnabled :

SNew(SButton)
.IsEnabled(bShowCreateBtn)
#Slate #FArguments #SLATE_ARGUMENT #SLATE_ATTRIBUTE #TAttribute
下一页 扰动贴图