WorldPartitionStreamingDescriptor.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Math/Box.h"
#include "Misc/HierarchicalLogArchive.h"
#include "UObject/SoftObjectPath.h"
#include "UObject/TopLevelAssetPath.h"
#include "Templates/SubclassOf.h"
 
#if WITH_EDITOR
 
class AActor;
class UWorld;
 
namespace UE::Private::WorldPartition
{
    struct FStreamingDescriptor
    {
        struct FStreamingActor
        {
            FTopLevelAssetPath BaseClass;
 
            FTopLevelAssetPath NativeClass;
 
            FSoftObjectPath Path;
 
            FName Package;
 
            FString Label;
 
            FGuid ActorGuid;
 
            void DumpStateLog(FHierarchicalLogArchive& Ar);
        };
 
        struct FStreamingCell
        {
            FBox Bounds;
 
            bool bIsAlwaysLoaded;
 
            bool bIsSpatiallyLoaded;
 
            TArray<FName> DataLayers;
 
            TArray<FStreamingActor> Actors;
 
            /* PackageName for this cell */
            FName CellPackage;
 
            void DumpStateLog(FHierarchicalLogArchive& Ar);
        };
 
        /* Represents a streaming grid */
        struct FStreamingGrid
        {
            /* Name of this grid */
            FName Name;
 
            FBox Bounds;
 
            int32 CellSize;
 
            int32 LoadingRange;
 
            TArray<FStreamingCell> StreamingCells;
 
            TArray<FString> ExternalStreamingObjects;
 
            void DumpStateLog(FHierarchicalLogArchive& Ar);
        };
 
        struct FStreamingDescriptorParams
        {
            TArray<TSubclassOf<AActor>> FilteredClasses;
        };
 
        TArray<FStreamingGrid> StreamingGrids;
 
        ENGINE_API void DumpStateLog(FHierarchicalLogArchive& Ar);
        ENGINE_API static bool GenerateStreamingDescriptor(UWorld* InWorld, FStreamingDescriptor& OutStreamingDescriptor, const FStreamingDescriptorParams& Params = FStreamingDescriptorParams());
 
        struct FGeneratedPackage
        {
            FName PackagePathName;
            bool bIsLevelPackage = false;
 
            bool operator==(const FGeneratedPackage&) const = default;
            FString ToString() { return PackagePathName.ToString(); }
        };
 
        ENGINE_API static TMap<FName, TArray<FGeneratedPackage>> GenerateWorldPluginPackagesList(UWorld* InWorld);
    };
};
 
#endif