IAssetCompilingManager.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/ContainersFwd.h"
#include "Containers/ArrayView.h"
 
class FName;
class FTextFormat;
class UObject;
 
namespace AssetCompilation
{
    struct FProcessAsyncTaskParams
    {
        /* Limits the execution time instead of processing everything */
        bool bLimitExecutionTime = false;
 
        /* Limits processing for assets required for PIE only. */
        bool bPlayInEditorAssetsOnly = false;
    };
}
 
struct IAssetCompilingManager
{
    virtual FName GetAssetTypeName() const = 0;
 
    virtual FTextFormat GetAssetNameFormat() const = 0;
 
    virtual TArrayView<FName> GetDependentTypeNames() const = 0;
 
    virtual int32 GetNumRemainingAssets() const = 0;
 
    virtual void FinishCompilationForObjects(TArrayView<UObject* const> InObjects) {} /* Optional for backward compatibility */
 
    virtual void MarkCompilationAsCanceled(TArrayView<UObject* const> InObjects) {} /* Optional for backward compatibility */
 
    virtual void FinishAllCompilation() = 0;
 
    virtual void Shutdown() = 0;
 
protected:
    friend class FAssetCompilingManager;
 
    virtual void ProcessAsyncTasks(bool bLimitExecutionTime = false) = 0;
 
    virtual void ProcessAsyncTasks(const AssetCompilation::FProcessAsyncTaskParams& Params)
    {
        /* Forward for backward compatibility */
        ProcessAsyncTasks(Params.bLimitExecutionTime);
    }
 
    virtual ~IAssetCompilingManager() {}
};