ExternalDataLayerHelper.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreFwd.h"
#include "Containers/StringView.h"
#include "Templates/Function.h"
 
class AActor;
class FAssetRegistryTagsContext;
class UExternalDataLayerAsset;
class UExternalDataLayerInstance;
struct FExternalDataLayerUID;
struct FAssetData;
 
struct FMoveToExternalDataLayerParams
{
    FMoveToExternalDataLayerParams()
        : ExternalDataLayerInstance (nullptr)
        , bAllowNonUserManaged(false)
    {}
 
    FMoveToExternalDataLayerParams(const UExternalDataLayerInstance* InExternalDataLayerInstance, bool bInAllowNonUserManaged = false)
        : ExternalDataLayerInstance(InExternalDataLayerInstance)
        , bAllowNonUserManaged(bInAllowNonUserManaged)
    {}
 
    const UExternalDataLayerInstance* ExternalDataLayerInstance;
    bool bAllowNonUserManaged;
};
 
class FExternalDataLayerHelper
{
public:
    static FString GetExternalStreamingObjectPackageName(const UExternalDataLayerAsset* InExternalDataLayerAsset);
 
    ENGINE_API static bool BuildExternalDataLayerRootPath(const FString& InEDLMountPoint, const FExternalDataLayerUID& InExternalDataLayerUID, FString& OutExternalDataLayerRootPath);
 
    ENGINE_API static bool BuildExternalDataLayerActorsRootPath(const FString& InEDLMountPoint, const FExternalDataLayerUID& InExternalDataLayerUID, FString& OutExternalDataLayerRootPath);
 
    ENGINE_API static FString GetExternalDataLayerLevelRootPath(const UExternalDataLayerAsset* InExternalDataLayerAsset, const FString& InLevelPackagePath);
 
    ENGINE_API static FString GetExternalDataLayerLevelRootPath(const FString& InEDLMountPoint, const FExternalDataLayerUID& InExternalDataLayerUID, const FString& InLevelPackagePath);
 
#if WITH_EDITOR
    ENGINE_API static bool IsExternalDataLayerPath(FStringView InExternalDataLayerPath, FExternalDataLayerUID* OutExternalDataLayerUID = nullptr);
 
    ENGINE_API static void AddAssetRegistryTags(FAssetRegistryTagsContext OutContext, const TArray<FExternalDataLayerUID>& InExternalDataLayerUIDs);
 
    ENGINE_API static void GetExternalDataLayerUIDs(const FAssetData& Asset, TArray<FExternalDataLayerUID>& OutExternalDataLayerUIDs);
 
    ENGINE_API static void ForEachExternalDataLayerLevelPackagePath(const FString& InLevelPackageName, TFunctionRef<void(const FString&)> Func);
 
    /* Returns the external actor package relative path for an actor package of an actor using External Data Layers.
     * InExternalDataLayerExternalActorPackagePath format is : /{MountPoint}/{ExternalActorFolder}/{ExternalDataLayerFolder}/{EDL_UID}/{ExternalActorPackagePath}
     * return format is : /{ExternalActorPackagePath}, empty otherwise
     */
    ENGINE_API static FStringView GetRelativeExternalActorPackagePath(FStringView InExternalDataLayerExternalActorPackagePath);
#endif
 
private:
 
#if WITH_EDITOR
    ENGINE_API static const UExternalDataLayerAsset* GetExternalDataLayerAssetFromObject(const UObject* InContextObject);
 
    ENGINE_API static bool CanMoveActorsToExternalDataLayer(const TArray<AActor*>& InActors, const FMoveToExternalDataLayerParams& InParams, FText* OutFailureReason = nullptr);
 
    ENGINE_API static bool MoveActorsToExternalDataLayer(const TArray<AActor*>& InActors, const UExternalDataLayerInstance* InExternalDataLayerInstance, FText* OutFailureReason = nullptr);
 
    ENGINE_API static bool MoveActorsToExternalDataLayer(const TArray<AActor*>& InActors, const FMoveToExternalDataLayerParams& InParams, FText* OutFailureReason = nullptr);
 
    friend class FDataLayerEditorModule;
    friend class UActorPartitionSubsystem;
    friend class UDataLayerEditorSubsystem;
    friend class UExternalDataLayerEngineSubsystem;
    friend class UContentBundleEditingSubmodule;
    friend class UGameFeatureActionConvertContentBundleWorldPartitionBuilder;
#endif
    static constexpr FStringView GetExternalDataLayerFolder() { return ExternalDataLayerFolder; }
    static constexpr FStringView ExternalDataLayerFolder = TEXTVIEW("/EDL/");
};