AssetImportData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "UObject/AssetRegistryTagsContext.h"
#include "UObject/ObjectMacros.h"
#include "UObject/Object.h"
#include "Misc/SecureHash.h"
#include "AssetImportData.generated.h"
 
USTRUCT()
struct FAssetImportInfo
{
    GENERATED_BODY()
    
#if WITH_EDITORONLY_DATA
 
    FAssetImportInfo() {}
 
    FAssetImportInfo(const FAssetImportInfo& In) : SourceFiles(In.SourceFiles) { }
    FAssetImportInfo& operator=(const FAssetImportInfo& In) { SourceFiles = In.SourceFiles; return *this; }
 
    FAssetImportInfo(FAssetImportInfo&& In) : SourceFiles(MoveTemp(In.SourceFiles)) { }
    FAssetImportInfo& operator=(FAssetImportInfo&& In) { SourceFiles = MoveTemp(In.SourceFiles); return *this; }
 
    struct FSourceFile
    {
        FSourceFile() = default;
 
        FSourceFile(FString InRelativeFilename, const FDateTime& InTimestamp = 0, const FMD5Hash& InFileHash = FMD5Hash(), const FString& InDisplayLabelName = FString())
            : RelativeFilename(MoveTemp(InRelativeFilename))
            , Timestamp(InTimestamp)
            , FileHash(InFileHash)
            , DisplayLabelName(InDisplayLabelName)
        {}
 
        FString RelativeFilename;
 
        FDateTime Timestamp;
 
        FMD5Hash FileHash;
 
        FString DisplayLabelName;
    };
 
    ENGINE_API FString ToJson() const;
 
    static ENGINE_API TOptional<FAssetImportInfo> FromJson(FString InJsonString);
 
    void Insert(const FSourceFile& InSourceFile) { SourceFiles.Add(InSourceFile); }
 
    TArray<FSourceFile> SourceFiles;
 
#endif // WITH_EDITORONLY_DATA
};
 
DECLARE_MULTICAST_DELEGATE_TwoParams(FOnImportDataChanged, const FAssetImportInfo& /*OldData*/, const class UAssetImportData* /* NewData */);
 
/* todo: Make this class better suited to multiple import paths - maybe have FAssetImportInfo use a map rather than array? */
UCLASS(EditInlineNew, MinimalAPI)
class UAssetImportData : public UObject
{
public:
    GENERATED_UCLASS_BODY()
 
    
    virtual bool IsEditorOnly() const override { return true; }
 
#if WITH_EDITOR
    UFUNCTION(BlueprintCallable, Category = "AssetImportData")
    ENGINE_API void ScriptedAddFilename(const FString& InPath, int32 Index, FString SourceFileLabel);
#endif //WITH_EDITOR
 
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY()
    FString SourceFilePath_DEPRECATED;
 
    UPROPERTY()
    FString SourceFileTimestamp_DEPRECATED;
 
    UPROPERTY(VisibleAnywhere, Category="File Path")
    FAssetImportInfo SourceData;
 
public:
 
    static ENGINE_API FOnImportDataChanged OnImportDataChanged;
 
    ENGINE_API void Update(const FString& AbsoluteFilename, FMD5Hash *Md5Hash = nullptr);
 
    //@third party BEGIN SIMPLYGON
    ENGINE_API void Update(const FString& AbsoluteFileName, const FMD5Hash PreComputedHash);
    //@third party END SIMPLYGON
 
    ENGINE_API void UpdateFilenameOnly(const FString& InPath);
 
    ENGINE_API void UpdateFilenameOnly(const FString& InPath, int32 Index);
 
    ENGINE_API void AddFileName(const FString& InPath, int32 Index, FString SourceFileLabel = FString());
 
    ENGINE_API void SetSourceFiles(TArray<FAssetImportInfo::FSourceFile>&& SourceFiles);
 
#if WITH_EDITOR
    UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
    virtual void AppendAssetRegistryTags(TArray<FAssetRegistryTag>& OutTags) {}
    virtual void AppendAssetRegistryTags(FAssetRegistryTagsContext Context) {}
 
    UFUNCTION(BlueprintCallable, meta=(DisplayName="GetFirstFilename", ScriptName="GetFirstFilename"), Category="AssetImportData")
    ENGINE_API FString K2_GetFirstFilename() const;
#endif
    ENGINE_API FString GetFirstFilename() const;
 
    const FAssetImportInfo& GetSourceData() const { return SourceData; }
 
#if WITH_EDITOR
    UFUNCTION(BlueprintCallable, meta=(DisplayName="ExtractFilenames", ScriptName="ExtractFilenames"), Category="AssetImportData")
    ENGINE_API TArray<FString> K2_ExtractFilenames() const;
#endif
    ENGINE_API TArray<FString> ExtractFilenames() const;
    ENGINE_API void ExtractFilenames(TArray<FString>& AbsoluteFilenames) const;
    
    ENGINE_API void ExtractDisplayLabels(TArray<FString>& FileDisplayLabels) const;
 
    int32 GetSourceFileCount() const { return SourceData.SourceFiles.Num(); }
 
    static ENGINE_API FString ResolveImportFilename(const FString& InRelativePath, const UPackage* Outermost);
    static ENGINE_API FString ResolveImportFilename(FStringView InRelativePath, FStringView OutermostPath);
 
    static ENGINE_API FString SanitizeImportFilename(const FString& InPath, const UPackage* Outermost);
    static ENGINE_API FString SanitizeImportFilename(const FString& InPath, const FString& PackagePath);
#if WITH_EDITOR
    virtual bool ConvertAssetImportDataToNewOwner(UObject* Owner)
    {
        return false;
    }
#endif
 
    ENGINE_API virtual void PostLoad() override;
 
    ENGINE_API FString SanitizeImportFilename(const FString& InPath) const;
 
protected:
 
    ENGINE_API FString ResolveImportFilename(const FString& InRelativePath) const;
 
    ENGINE_API virtual void Serialize(FStructuredArchive::FRecord Record) override;
    
#endif      // WITH_EDITORONLY_DATA
};