In some code paths for loaded actors the call order might be different since primitive registration gets deferred (i.e. FRegisterComponentContext != nullptr).
Case 1 (normal flow): FRegisterComponentContext == nullptr
> UPrimitiveComponent::CreateRenderState_Concurrent : calls CreateSceneProxy
> RegisterDebugDrawDelegate
> UnregisterDebugDrawDelegate ==> works fine
Case 2 (deferred AddPrimitive): FRegisterComponentContext != nullptr
> UPrimitiveComponent::CreateRenderState_Concurrent : defers CreateSceneProxy
> RegisterDebugDrawDelegate (skip register since not init)
> CreateSceneProxy
> UnregisterDebugDrawDelegate ==> ensures in UnregisterDebugDrawDelegate
With this new version `CreateRenderState_Concurrent` calls `RequestRegisterDebugDrawDelegate` that will take care of registering the delegate immediately or mark it for deferred execution. An explicit call to `ProcessDeferredRegister` is then required from `CreateSceneProxy` to implement proper flow:
Case 2 (fixed) (deferred AddPrimitive + deferred Register): FRegisterComponentContext != nullptr
> UPrimitiveComponent::CreateRenderState_Concurrent: defers CreateSceneProxy
> RequestRegisterDebugDrawDelegate: defers RegisterDebugDrawDelegate
> CreateSceneProxy: calls ProcessDeferredRegister & RegisterDebugDrawDelegate
> UnregisterDebugDrawDelegate ==> works fine
Bonus:
- New DebugDrawComponent abstract class that is now used to share common functionalities between existing debug related components. Takes care of DelegateHelper registration flow to render text on screen from different sources.
- FDebugDrawDelegateHelper::InitDelegateHelper is no longer virtual and derived classes requiring extra data from their associated scene proxy should set it up from their overriden CreateSceneProxy
- FDebugDrawDelegateHelper derived classes should not override RegisterDebugDrawDelegate/UnregisterDebugDrawDelegate to use their `DrawDebugLabels` method since this is already a virtual method that would get called from the base class.
- Fixed a few ViewFlag members in the SceneProxy so the DelegateHelper base class can behave as expected
#jira FORT-419154
#rb mieszko.zielinski
#robomerge FnMain
#preflight 61703f8766ed7f0001c0faf1
[CL 17875336 by Yoan StAmant in ue5-main branch]
Update registration flow since CreateRenderState_Concurrent can't be used to register our delegate since it needs to be initialized first (CreateSceneProxy) and in some code paths for loaded actors the call order might be different since primitive registration gets deferred (i.e. FRegisterComponentContext != nullptr).
In that case initialization won't called and an ensure will fire in UnregisterDebugDrawDelegate since registration failed (was not initialized).
Case 1: FRegisterComponentContext == nullptr ==> Super::CreateRenderState_Concurrent + sync CreateSceneProxy (init) + RegisterDebugDrawDelegate ==> works fine
Case 2: FRegisterComponentContext != nullptr ==> Super::CreateRenderState_Concurrent + deferred CreateSceneProxy + RegisterDebugDrawDelegate (skipped since not init) + CreateSceneProxy ==> ensures in UnregisterDebugDrawDelegate
Bonus:
- some code analysis fixes
- removed some 'CoreMinimal.h' includes
- exported log category 'LogVisual'
- fixed some uninitialized properties (FNavTestDebugDrawDelegateHelper, UNavMeshRenderingComponent, FNavMeshSceneProxyData)
- fixed some methods hiding non-virtual from base class (GetAllocatedSize)
- fixed FGameplayDebuggerCompositeSceneProxy::GetMemoryFootprint that was not considering base class allocations
#rnx
#jira UE-125097
#preflight 614362684778fa00016a8cad
#rb mieszko.zielinski
[CL 17544171 by Yoan StAmant in ue5-main branch]
#rb trivial
Removed reference to ue4
#ROBOMERGE-SOURCE: CL 15801766 in //UE5/Release-5.0-EarlyAccess/...
#ROBOMERGE-BOT: STARSHIP (Release-5.0-EarlyAccess -> Main) (v783-15756269)
[CL 15807997 by mark lintott in ue5-main branch]
