LinkerInstancingContext.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "UObject/SoftObjectPath.h"
 
class FLinkerInstancedPackageMap
{
public:
    enum class EInstanceMappingDirection : uint8
    {
        OriginalToInstanced,
        InstancedToOriginal,
    };
 
    FLinkerInstancedPackageMap() :
        FLinkerInstancedPackageMap(EInstanceMappingDirection::OriginalToInstanced) {}
 
    explicit FLinkerInstancedPackageMap(EInstanceMappingDirection MappingDirection)
        : InstanceMappingDirection(MappingDirection)
        , bIsInstanced(false)
#if WITH_EDITOR
        , bEnableNonEditorPath(false)
#else
        , bEnableNonEditorPath(true)
#endif
    {
    }
 
    bool IsInstanced() const
    {
        return bIsInstanced;
    }
 
    FName RemapPackage(const FName& PackageName, bool* bWasFoundPtr = nullptr) const
    {
        if (const FName* RemappedName = InstancedPackageMapping.Find(PackageName))
        {
            if (bWasFoundPtr)
            {
                *bWasFoundPtr = true;
            }
            return *RemappedName;
        }
        if (bWasFoundPtr)
        {
            *bWasFoundPtr = false;
        }
        return PackageName;
    }
    
    COREUOBJECT_API void AddPackageMapping(FName Original, FName Instanced);
 
    COREUOBJECT_API void BuildPackageMapping(FName Original, FName Instanced, const bool bBuildWorldPartitionCellMapping = true);
 
    COREUOBJECT_API bool FixupSoftObjectPath(FSoftObjectPath& InOutSoftObjectPath) const;
 
private:
    friend class FLinkerInstancingContext;
    friend class FLinkerInstancingContextTests;
    void EnableAutomationTest() { bEnableNonEditorPath = true; }
 
    TMap<FName, FName> InstancedPackageMapping;
 
    EInstanceMappingDirection InstanceMappingDirection;
 
    FString GeneratedPackagesFolder;
    FString InstancedPackagePrefix;
    FString InstancedPackageSuffix;
 
    bool bIsInstanced;
 
    bool bEnableNonEditorPath;
};
 
class FLinkerInstancingContext
{
public:
    COREUOBJECT_API FLinkerInstancingContext();
    COREUOBJECT_API explicit FLinkerInstancingContext(TSet<FName> InTags);
    COREUOBJECT_API explicit FLinkerInstancingContext(bool bInSoftObjectPathRemappingEnabled);
 
    COREUOBJECT_API static FLinkerInstancingContext DuplicateContext(const FLinkerInstancingContext& InLinkerInstancingContext);
 
    COREUOBJECT_API bool IsInstanced() const;
 
    COREUOBJECT_API FName RemapPackage(const FName& PackageName) const;
 
    COREUOBJECT_API FSoftObjectPath RemapPath(const FSoftObjectPath& Path) const;
 
    COREUOBJECT_API void AddPackageMapping(FName Original, FName Instanced);
 
    COREUOBJECT_API void AddPackageMappingFunc(TFunction<FName(FName)> InInstancedPackageMapFunc);
    
    COREUOBJECT_API void AddPathMapping(FSoftObjectPath Original, FSoftObjectPath Instanced);
 
    COREUOBJECT_API void AddTag(FName NewTag);
    COREUOBJECT_API void AppendTags(const TSet<FName>& NewTags);
    COREUOBJECT_API bool HasTag(FName Tag) const;
    COREUOBJECT_API void SetSoftObjectPathRemappingEnabled(bool bInSoftObjectPathRemappingEnabled);
    COREUOBJECT_API bool GetSoftObjectPathRemappingEnabled() const;
 
    UE_DEPRECATED(5.2, "No longer used, pass ELoadFlags::LOAD_RegenerateBulkDataGuids to LoadPackage instead")
    void SetRegenerateUniqueBulkDataGuids(bool bFlag) { }
 
    UE_DEPRECATED(5.2, "No longer used, check ELoadFlags::LOAD_RegenerateBulkDataGuids in the LoadFlags instead")
    bool ShouldRegenerateUniqueBulkDataGuids() const { return false; }
 
    static FString GetInstancedPackageName(const FString& InOuterPackageName, const FString& InPackageName)
    {
        return FString::Printf(TEXT("%s_InstanceOf_%s"), *InOuterPackageName, *InPackageName);
    }
 
    static FName GetInstancedPackageName(FName InOuterPackageName, FName InPackageName)
    {
        return *GetInstancedPackageName(InOuterPackageName.ToString(), InPackageName.ToString());
    }
 
    COREUOBJECT_API void FixupSoftObjectPath(FSoftObjectPath& InOutSoftObjectPath) const;
 
private:
    void EnableAutomationTest();
    void BuildPackageMapping(FName Original, FName Instanced);
    bool FindPackageMapping(FName Original, FName& Instanced) const;
 
    friend class FLinkerLoad;
    friend struct FAsyncPackage2;
    friend class FLinkerInstancingContextTests;
    class FSharedLinkerInstancingContextData;
 
    TSharedPtr<FSharedLinkerInstancingContextData> SharedData;
};