IWorldPartitionHLODUtilities.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Containers/Array.h"
#include "WorldPartition/WorldPartitionHandle.h"
#include "WorldPartition/WorldPartitionStreamingGenerationContext.h"
#include "WorldPartition/DataLayer/DataLayersID.h"
 
#if WITH_EDITOR
 
#include "WorldPartition/DataLayer/ExternalDataLayerAsset.h"
#include "WorldPartition/DataLayer/ExternalDataLayerInstance.h"
 
class AActor;
class UWorldPartition;
class UHLODLayer;
class UHLODBuilder;
class UHLODBuilderSettings;
class AWorldPartitionHLOD;
 
struct FHLODCreationContext
{
    TMap<FName, FWorldPartitionHandle> HLODActorDescs;
    TArray<FWorldPartitionReference> ActorReferences;
};
 
struct FHLODCreationParams
{
    UWorldPartition* WorldPartition;
    UWorld* TargetWorld;
 
    FGuid CellGuid;
    FString CellName;
    TUniqueFunction<FName(const UHLODLayer*)> GetRuntimeGrid;
    uint32 HLODLevel;
    FGuid ContentBundleGuid;
    TArray<const UDataLayerInstance*> DataLayerInstances;
    bool bIsStandalone;
 
    const UExternalDataLayerAsset* GetExternalDataLayerAsset() const
    {
        auto IsAnExternalDataLayerPred = [](const UDataLayerInstance* DataLayerInstance) { return DataLayerInstance->IsA<UExternalDataLayerInstance>(); };
        if (const UDataLayerInstance* const* ExternalDataLayerInstance = DataLayerInstances.FindByPredicate(IsAnExternalDataLayerPred))
        {
            return CastChecked<UExternalDataLayerInstance>(*ExternalDataLayerInstance)->GetExternalDataLayerAsset();
        }
        return nullptr;
    }
 
    double MinVisibleDistance;
    
    UE_DEPRECATED(5.7, "CellBounds member is not used anymore.")
    FBox CellBounds;
};
 
class IWorldPartitionHLODUtilities
{
public:
    virtual ~IWorldPartitionHLODUtilities() {}
 
    virtual TArray<AWorldPartitionHLOD*> CreateHLODActors(FHLODCreationContext& InCreationContext, const FHLODCreationParams& InCreationParams, const TArray<IStreamingGenerationContext::FActorInstance>& InActors) = 0;
 
    virtual uint32 BuildHLOD(AWorldPartitionHLOD* InHLODActor) = 0;
 
    virtual uint32 ComputeHLODHash(const AWorldPartitionHLOD* InHLODActor) = 0;
 
    virtual TSubclassOf<UHLODBuilder> GetHLODBuilderClass(const UHLODLayer* InHLODLayer) = 0;
 
    virtual UHLODBuilderSettings* CreateHLODBuilderSettings(UHLODLayer* InHLODLayer) = 0;
 
    UE_EXPERIMENTAL(5.7, "Experimental API, HLOD build evaluator logic may be moved in a future release.")
    DECLARE_DELEGATE_RetVal_ThreeParams(bool, FHLODBuildEvaluator, AWorldPartitionHLOD*, uint32, uint32);
 
    UE_EXPERIMENTAL(5.7, "Experimental API, HLOD build evaluator logic may be moved in a future release.")
    virtual void SetHLODBuildEvaluator(FHLODBuildEvaluator BuildEvaluatorDelegate) = 0;
 
 
    UE_DEPRECATED(5.2, "Use the overload that passes the DataLayersInstances via InCreationParams")
    virtual TArray<AWorldPartitionHLOD*> CreateHLODActors(FHLODCreationContext& InCreationContext, const FHLODCreationParams& InCreationParams, const TArray<IStreamingGenerationContext::FActorInstance>& InActors, const TArray<const UDataLayerInstance*>& InDataLayerInstances)
    {
        const_cast<FHLODCreationParams&>(InCreationParams).DataLayerInstances = InDataLayerInstances;
        return CreateHLODActors(InCreationContext, InCreationParams, InActors);
    }
};
#endif