AssetCompilingManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Delegates/Delegate.h"
#include "UObject/WeakObjectPtr.h"
#include "UObject/Class.h"
#include "UObject/ObjectMacros.h"
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_4
#include "CoreMinimal.h"
#include "Interfaces/Interface_AsyncCompilation.h"
#include "IAssetCompilingManager.h"
#endif
#include "AssetCompilingManager.generated.h"
 
class FQueuedThreadPool;
struct IAssetCompilingManager;
 
namespace AssetCompilation
{
    struct FProcessAsyncTaskParams;
}
 
USTRUCT(BlueprintType)
struct FAssetCompileData
{
    GENERATED_BODY();
 
    UPROPERTY(BlueprintReadWrite, Category = AssetCompileData)
    TWeakObjectPtr<UObject> Asset;
 
    FAssetCompileData()
    {}
 
    FAssetCompileData(const TWeakObjectPtr<UObject>& InAsset)
        : Asset(InAsset)
    {
    }
};
 
DECLARE_TS_MULTICAST_DELEGATE_OneParam(FAssetPostCompileEvent, const TArray<FAssetCompileData>&);
 
class FAssetCompilingManager
{
public:
    ENGINE_API static FAssetCompilingManager& Get();
 
    ENGINE_API bool RegisterManager(IAssetCompilingManager* InAssetCompilingManager);
 
    ENGINE_API bool UnregisterManager(IAssetCompilingManager* InAssetCompilingManager);
 
    ENGINE_API TArrayView<IAssetCompilingManager* const> GetRegisteredManagers() const;
 
    ENGINE_API int32 GetNumRemainingAssets() const;
 
    ENGINE_API void FinishAllCompilation();
 
    ENGINE_API void FinishCompilationForObjects(TArrayView<UObject* const> InObjects);
 
    ENGINE_API void MarkCompilationAsCanceled(TArrayView<UObject* const> InObjects);
 
    ENGINE_API void Shutdown();
 
    ENGINE_API FQueuedThreadPool* GetThreadPool() const;
 
    ENGINE_API void ProcessAsyncTasks(bool bLimitExecutionTime = false);
 
    ENGINE_API void ProcessAsyncTasks(const AssetCompilation::FProcessAsyncTaskParams& Params);
 
    FAssetPostCompileEvent& OnAssetPostCompileEvent() { return AssetPostCompileEvent; }
 
    DECLARE_MULTICAST_DELEGATE_TwoParams(FPackageScopeEvent, UPackage*, bool);
    FPackageScopeEvent& OnPackageScopeEvent() { return PackageScopeEvent; }
 
private:
    FAssetCompilingManager();
    ~FAssetCompilingManager();
    friend struct IAssetCompilingManager;
 
    void UpdateNumRemainingAssets();
 
    bool bHasShutdown = false;
    int32 LastNumRemainingAssets = 0;
 
    TArray<IAssetCompilingManager*> AssetCompilingManagers;
    TArray<IAssetCompilingManager*> AssetCompilingManagersWithValidDependencies;
 
    FAssetPostCompileEvent AssetPostCompileEvent;
 
    FPackageScopeEvent PackageScopeEvent;
};