为虚幻引擎5.2升级Control Rig的C++单元 | 虚幻引擎 5.4 文档

在 虚幻引擎 5.2中，对Control Rig FRigVMStruct 和 FRigUnit 在项目的 C++ 代码库中的实现方式做了重大改变。术语和自定义 FRigVMStruct 结构内的 上下文（Context） 概念的扩展使用，需要对这些结构体进行重构。

你可以使用该文档来了解更多关于如何迁移你的Control Rig代码，以便使其兼容虚幻引擎5.2的信息。

执行签名变更

在以前版本的虚幻引擎中，FRigVMExecuteContext 成员被视为每个RigVM方法的参数。在虚幻引擎5.2中，执行上下文的成员将不再被传递。相反，一个名为 ExecuteContext 的单一参数被传递给所有RigVM方法。该参数可以是一个 常数（const） 或 可变量（mutable），这取决于它在结构体中的用法。

要查看与 FRigUnitContext 相关的变化，请参阅不透明参数和FRigUnitContext部分。

此处，你可以参考一个从虚幻引擎5.1到5.2的签名变更的例子，,FRigUnit 如 FRigUnit_SendEvent 是 FRigUnit_SendEvent::Execute 的签名：

5.1 Signature 5.2 Signature

5.1 Signature	5.2 Signature
`void FRigUnit_SendEvent::StaticExecute( const FRigVMExecuteContext& RigVMExecuteContext, const ERigEvent Event, const FRigElementKey& Item, const float OffsetInSeconds, const bool bEnable, const bool bOnlyDuringInteraction, FControlRigExecuteContext& ExecuteContext, const FRigUnitContext & Context )` void FRigUnit_SendEvent::StaticExecute( const FRigVMExecuteContext& RigVMExecuteContext, const ERigEvent Event, const FRigElementKey& Item, const float OffsetInSeconds, const bool bEnable, const bool bOnlyDuringInteraction, FControlRigExecuteContext& ExecuteContext, const FRigUnitContext & Context )	`void FRigUnit_SendEvent::StaticExecute( FControlRigExecuteContext& ExecuteContext, const ERigEvent Event, const FRigElementKey& Item, const float OffsetInSeconds, const bool bEnable, const bool bOnlyDuringInteraction )` void FRigUnit_SendEvent::StaticExecute( FControlRigExecuteContext& ExecuteContext, const ERigEvent Event, const FRigElementKey& Item, const float OffsetInSeconds, const bool bEnable, const bool bOnlyDuringInteraction )

void FRigUnit_SendEvent::StaticExecute(
	const FRigVMExecuteContext& RigVMExecuteContext,
	const ERigEvent Event,
	const FRigElementKey& Item,
	const float OffsetInSeconds,
	const bool bEnable,
	const bool bOnlyDuringInteraction,
	FControlRigExecuteContext& ExecuteContext,
	const FRigUnitContext & Context
)

void FRigUnit_SendEvent::StaticExecute(
	FControlRigExecuteContext& ExecuteContext,
	const ERigEvent Event,
	const FRigElementKey& Item,
	const float OffsetInSeconds,
	const bool bEnable,
	const bool bOnlyDuringInteraction
)

由于新的 ExecuteContext 参数提供了对 const 或 mutable 上下文的访问，我们移除了 RigVMExecuteContext 参数。

不透明参数和FRigUnitContext

以前特定领域的 RIGVM_METHOD 实现可以选择传递额外的 不透明参数（opaque arguments）。在虚幻引擎5.2中，对于不透明参数的支持已被移除。这种机制以前唯一的用法是Control Rig节点的 FRigUnitContext。依靠访问 FRigUnitContext 上下文 参数的代码必须更新至使用 ExecuteContext.UnitContext 以确保兼容性。

成员从FRigUnitContext移动至FRigExecuteContext

这里你可以参考从 FRigUnitContext 转移到 FRigExecuteContext 的成员列表：

5.1中移除的参数	5.2中重构的参数
`FRigUnitContext::DrawInterface`	`FRigVMExecuteContext::GetDrawInterface();`
`FRigUnitContext::DrawContainer`	`FRigVMExecuteContext::GetDrawContainer();`
`FRigUnitContext::DeltaTime`	`FRigVMExecuteContext::GetDeltaTime();`
`FRigUnitContext::AbsoluteTime`	`FRigVMExecuteContext::GetAbsoluteTime();`
`FRigUnitContext::FramesPerSecond`	`FRigVMExecuteContext::GetFramesPerSecond();`
`FRigUnitContext::Hierarchy`	`FControlRigExecuteContext::Hierarchy;`
`FRigUnitContext::ToWorldSpaceTransform`	`FRigUnitContext::GetToWorldSpaceTransform();`
`FRigUnitContext::OwningComponent`	`FRigUnitContext::GetOwningComponent();`
`FRigUnitContext::OwningActor`	`FRigUnitContext::GetOwningActor();`
`FRigUnitContext::World`	`FRigUnitContext::GetWorld();`
`FRigUnitContext::Log`	`FRigVMExecuteContext::GetLog();`
`FRigUnitContext::NameCache`	`FRigVMExecuteContext::GetNameCache();`

所有与转换相关的辅助函数也都转移到了 FRigVMExecuteContext 中。

移除FRigUnitContext.State

Control Rig和RigVM不再以 初始（Init） 或 更新（Update） 状态多次调用RIGVM_METHOD回调。相反，它在初始状态期间将内存重置为默认值，然后一直运行过去被认为是更新的状态。这意味着你可能需要改变你的代码，从过去依赖初始状态进行初始化，改为使用 未初始化标志 或类似方法来确定是否需要初始化。

示例

你可以在这里参考虚幻引擎源码树中的一个重构代码的例子。你也可以使用虚幻引擎GitHub源码树来对比额外的重构，例如在不同的版本之间使用Control Rig节点。

5.1 FRigUnit_SendEvent::Execute() 5.2 FRigUnit_SendEvent::Execute()

5.1 FRigUnit_SendEvent::Execute()	5.2 FRigUnit_SendEvent::Execute()
~~~ FRigUnit_SendEvent_Execute() { DECLARE_SCOPE_HIERARCHICAL_COUNTER_RIGUNIT() if(!bEnable) { return; } if (bOnlyDuringInteraction && !Context.IsInteracting()) { return; } URigHierarchy Hierarchy = ExecuteContext.Hierarchy; if (Hierarchy) { switch (Context.State) { case EControlRigState::Init: { break; } case EControlRigState::Update: { FRigEventContext EventContext; EventContext.Key = Item; EventContext.Event = Event; EventContext.SourceEventName = ExecuteContext.GetEventName(); EventContext.LocalTime = Context.AbsoluteTime + OffsetInSeconds; Hierarchy->SendEvent(EventContext, false / async /); break; } default: { break; } } } } FRigUnit_SendEvent_Execute() { DECLARE_SCOPE_HIERARCHICAL_COUNTER_RIGUNIT() if(!bEnable) { return; } if (bOnlyDuringInteraction && !ExecuteContext.UnitContext.IsInteracting()) { return; } URigHierarchy Hierarchy = ExecuteContext.Hierarchy; if (Hierarchy) { FRigEventContext EventContext; EventContext.Key = Item; EventContext.Event = Event; EventContext.SourceEventName = ExecuteContext.GetEventName(); EventContext.LocalTime = ExecuteContext.GetAbsoluteTime() + OffsetInSeconds; Hierarchy->SendEvent(EventContext, false / async /); } } ~~~

~~~ FRigUnit_SendEvent_Execute() { DECLARE_SCOPE_HIERARCHICAL_COUNTER_RIGUNIT()

if(!bEnable) { return; }

if (bOnlyDuringInteraction && !Context.IsInteracting()) { return; }

URigHierarchy Hierarchy = ExecuteContext.Hierarchy; if (Hierarchy) { switch (Context.State) { case EControlRigState::Init: { break; } case EControlRigState::Update: { FRigEventContext EventContext; EventContext.Key = Item; EventContext.Event = Event; EventContext.SourceEventName = ExecuteContext.GetEventName(); EventContext.LocalTime = Context.AbsoluteTime + OffsetInSeconds; Hierarchy->SendEvent(EventContext, false / async */); break; } default: { break; } } } }

FRigUnit_SendEvent_Execute() { DECLARE_SCOPE_HIERARCHICAL_COUNTER_RIGUNIT()

if(!bEnable) { return; }

if (bOnlyDuringInteraction && !ExecuteContext.UnitContext.IsInteracting()) { return; }

URigHierarchy Hierarchy = ExecuteContext.Hierarchy; if (Hierarchy) { FRigEventContext EventContext; EventContext.Key = Item; EventContext.Event = Event; EventContext.SourceEventName = ExecuteContext.GetEventName(); EventContext.LocalTime = ExecuteContext.GetAbsoluteTime() + OffsetInSeconds; Hierarchy->SendEvent(EventContext, false / async */); } } ~~~