InterchangeSourceData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Misc/Paths.h"
#include "Misc/SecureHash.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
 
#include "InterchangeSourceData.generated.h"
 
/*
 * Helper class to be able to read different source data
 * File on disk
 * HTTP URL (TODO)
 * Memory buffer (TODO)
 * Stream (TODO)
 */
 
UCLASS(BlueprintType, Blueprintable, MinimalAPI)
class UInterchangeSourceData : public UObject
{
     GENERATED_BODY()
 
public:
    INTERCHANGECORE_API UInterchangeSourceData();
 
    INTERCHANGECORE_API UInterchangeSourceData(FString InFilename);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Import Manager")
    inline FString GetFilename() const
    {
        return Filename;
    }
 
    inline TOptional<FMD5Hash> GetFileContentHash() const
    {
        TRACE_CPUPROFILER_EVENT_SCOPE(UInterchangeSourceData::GetFileContentHash);
        if(!FileContentHashCache.IsSet())
        {
            ComputeFileContentHashCache();
        }
        return FileContentHashCache;
    }
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Import Manager")
    inline bool SetFilename(const FString& InFilename)
    {
        Filename = FPaths::ConvertRelativePathToFull(InFilename);
        //Reset the cache
        FileContentHashCache.Reset();
        return true;
    }
 
    inline FString ToDisplayString() const
    {
        if (!Filename.IsEmpty())
        {
            bool bFileExist = FPaths::FileExists(Filename);
            FString CleanFilename = FPaths::GetCleanFilename(Filename);
            FString BasePath = FPaths::GetPath(Filename);
            //limit the base path to 20 character do ellipsis in the middle
            if (BasePath.Len() > 43)
            {
                FString RightPath = BasePath.Right(20);
                FString LeftPath = BasePath.Left(20);
                BasePath = LeftPath + TEXT("...") + RightPath;
            }
            FString DisplayString = BasePath + TEXT("/") + CleanFilename;
            return DisplayString;
        }
        return FString();
    }
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Import Manager")
    INTERCHANGECORE_API UObject* GetContextObjectByTag(const FString& Tag) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Import Manager")
    INTERCHANGECORE_API void SetContextObjectByTag(const FString& Tag, UObject* Object) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Import Manager")
    INTERCHANGECORE_API TArray<FString> GetAllContextObjectTags() const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Import Manager")
    INTERCHANGECORE_API void RemoveAllContextObjects() const;
 
private:
    void INTERCHANGECORE_API ComputeFileContentHashCache() const;
 
    UPROPERTY()
    FString Filename;
 
    mutable TOptional<FMD5Hash> FileContentHashCache;
 
    UPROPERTY()
    mutable TMap<FString, TObjectPtr<UObject>> ContextObjectsByTag;
};