InterchangeImportCommon.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "EditorFramework/AssetImportData.h"
 
#define UE_API INTERCHANGEENGINE_API
 
class UAssetImportData;
class UInterchangeAssetImportData;
class UInterchangeBaseNode;
class UInterchangeBaseNodeContainer;
class UInterchangeFactoryBase;
class UInterchangeFactoryBaseNode;
class UInterchangePipelineBase;
class UInterchangeSourceData;
class UInterchangeTranslatorBase;
class UObject;
template <typename FuncType> class TFunctionRef;
 
namespace UE::Interchange
{
    class FFactoryCommon
    {
    public:
 
        struct FUpdateImportAssetDataParameters
        {
            UObject* AssetImportDataOuter = nullptr;
            UAssetImportData* AssetImportData = nullptr;
            const UInterchangeSourceData* SourceData = nullptr;
            FString NodeUniqueID;
            UInterchangeBaseNodeContainer* NodeContainer;
            const TArray<UObject*> Pipelines;
            const UInterchangeTranslatorBase* Translator;
 
            UE_API FUpdateImportAssetDataParameters(UObject* InAssetImportDataOuter
                                                                , UAssetImportData* InAssetImportData
                                                                , const UInterchangeSourceData* InSourceData
                                                                , FString InNodeUniqueID
                                                                , UInterchangeBaseNodeContainer* InNodeContainer
                                                                , const TArray<UObject*>& InPipelines
                                                                , const UInterchangeTranslatorBase* InTranslator);
        };
 
        static UE_API UAssetImportData* UpdateImportAssetData(FUpdateImportAssetDataParameters& Parameters);
 
        static UE_API UAssetImportData* UpdateImportAssetData(FUpdateImportAssetDataParameters& Parameters, TFunctionRef<void(UInterchangeAssetImportData*)> CustomFileSourceUpdate);
 
#if WITH_EDITORONLY_DATA
        struct FSetImportAssetDataParameters : public FUpdateImportAssetDataParameters
        {
            // Allow the factory to provide is own list of source files.
            TArray<FAssetImportInfo::FSourceFile> SourceFiles;
 
            UE_API FSetImportAssetDataParameters(UObject* InAssetImportDataOuter
                , UAssetImportData* InAssetImportData
                , const UInterchangeSourceData* InSourceData
                , FString InNodeUniqueID
                , UInterchangeBaseNodeContainer* InNodeContainer
                , const TArray<UObject*>& InPipelines
                , const UInterchangeTranslatorBase* InTranslator);
        };
 
        static UE_API UAssetImportData* SetImportAssetData(FSetImportAssetDataParameters& Parameters);
 
        static UE_API bool GetSourceFilenames(const UAssetImportData* AssetImportData, TArray<FString>& OutSourceFilenames);
 
        static UE_API void BackupSourceData(const UAssetImportData* AssetImportData);
 
        static UE_API void ReinstateSourceData(UAssetImportData* AssetImportData);
 
        static UE_API void ClearBackupSourceData(const UAssetImportData* AssetImportData);
 
        static UE_API bool SetSourceFilename(UAssetImportData* AssetImportData, const FString& SourceFilename, int32 SourceIndex, const FString& SourceLabel = FString());
 
        static UE_API bool SetReimportSourceIndex(const UObject* Object, UAssetImportData* AssetImportData, int32 SourceIndex);
 
#endif // WITH_EDITORONLY_DATA
 
        static UE_API void ApplyReimportStrategyToAsset(UObject* Asset
                                            , const UInterchangeFactoryBaseNode* PreviousAssetNode
                                            , const UInterchangeFactoryBaseNode* CurrentAssetNode
                                            , UInterchangeFactoryBaseNode* PipelineAssetNode);
 
        static  UE_API UObject* GetObjectToReimport(UInterchangeFactoryBase* Factory, UObject* ReimportObject, const UInterchangeFactoryBaseNode& FactoryNode, const FString& PackageName, const FString& AssetName, const FString& SubPathString = FString());
 
        static  UE_API const UInterchangeFactoryBaseNode* GetFactoryNode(UObject* ReimportObject, const FString& PackageName, const FString& AssetName, const FString& SubPathString = FString());
 
        static  bool UE_API CanProceedWithFactoryNode(UInterchangeFactoryBaseNode& FactoryNode, UObject* ReimportObject, UObject* ObjectToReimport, const FString& PackageName, const FString& AssetName, const FString& SubPathString = FString());
        static UE_API UObject* AsyncFindObject(UInterchangeFactoryBaseNode* FactoryNode, const UClass* FactoryClass, UObject* Parent, const FString& AssetName);
    };
} //ns UE::Interchange
 
#undef UE_API