SpawnActorTimer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "HAL/PlatformTime.h"
 
// Define that controls compilation of this feature
#if (!UE_BUILD_SHIPPING && 1)
#define ENABLE_SPAWNACTORTIMER 1
#else
#define ENABLE_SPAWNACTORTIMER 0
#endif
 
#if ENABLE_SPAWNACTORTIMER
 
struct FSpawnActorTimingInfo
{
    FName ClassName;
    double SpawnTime;
};
 
enum class ESpawnActorTimingType
{
    SpawnActorNonDeferred,
    SpawnActorDeferred,
    FinishSpawning
};
 
class FSpawnActorTimer
{
public:
    FSpawnActorTimer()
        : bIsRecordingSpawnActorTimes(false)
        , FrameCount(0)
    {}
 
    void ReportSpawnActor(FName ClassName, FName ActorName, double SpawnTime, ESpawnActorTimingType SpawnActorType);
 
    void IncrementFrameCount();
 
    static FSpawnActorTimer& Get();
 
    static void SpawnActorTimerCmdFunc(const TArray<FString>& Args);
 
private:
 
    void Start();
    void Stop();
    void OutputSpawnTimings();
 
    bool bIsRecordingSpawnActorTimes;
 
    TArray<FSpawnActorTimingInfo> SpawnActorInfos;
 
    TMap<FName, FSpawnActorTimingInfo> IncompleteSpawnActorMap;
 
    int32 FrameCount;
};
 
class FScopedSpawnActorTimer
{
public:
    FScopedSpawnActorTimer(FName InClassName, ESpawnActorTimingType InSpawnActorType)
        : StartTime(FPlatformTime::Seconds())
        , ClassName(InClassName)
        , ActorName(NAME_None)
        , SpawnActorType(InSpawnActorType)
    {
    }
 
    ~FScopedSpawnActorTimer()
    {
        double StopTime = FPlatformTime::Seconds();
        double ElapsedTime = StopTime - StartTime;
        FSpawnActorTimer::Get().ReportSpawnActor(ClassName, ActorName, ElapsedTime, SpawnActorType);
    }
 
    void SetActorName(FName InActorName)
    {
        ActorName = InActorName;
    }
 
private:
    double StartTime;
    FName ClassName;
    FName ActorName;
    ESpawnActorTimingType SpawnActorType;
};
 
#endif // ENABLE_SPAWNACTORTIMER