HLODLayer.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "EngineDefines.h"
#include "UObject/ObjectMacros.h"
#include "UObject/UObjectGlobals.h"
#include "UObject/Object.h"
 
#include "EngineDefines.h"
#include "MeshMerge/MeshMergingSettings.h"
#include "MeshMerge/MeshProxySettings.h"
#include "MeshMerge/MeshApproximationSettings.h"
 
#include "WorldPartition/HLOD/HLODBuilder.h"
 
#include "HLODLayer.generated.h"
 
class AActor;
class AWorldPartitionHLOD;
class UHLODBuilder;
class UHLODBuilderSettings;
class FHLODHashBuilder;
class UMaterial;
class UWorldPartition;
class UWorldPartitionHLODModifier;
class FWorldPartitionActorDesc;
 
UENUM()
enum class EHLODLayerType : uint8
{
    Instancing              UMETA(DisplayName = "Instancing"),
    MeshMerge               UMETA(DisplayName = "Merged Mesh"),
    MeshSimplify            UMETA(DisplayName = "Simplified Mesh"),
    MeshApproximate         UMETA(DisplayName = "Approximated Mesh"),
    Custom                  UMETA(DisplayName = "Custom Builder"),
    CustomHLODActor         UMETA(DisplayName = "Custom HLOD Actor"),
};
 
UCLASS(Blueprintable, MinimalAPI)
class UHLODLayer : public UObject
{
    GENERATED_UCLASS_BODY()
    
#if WITH_EDITOR
public:
    static ENGINE_API UHLODLayer* GetEngineDefaultHLODLayersSetup();
 
    static ENGINE_API UHLODLayer* DuplicateHLODLayersSetup(UHLODLayer* HLODLayer, const FString& DestinationPath, const FString& Prefix);
 
    EHLODLayerType GetLayerType() const { return LayerType; }
    void SetLayerType(EHLODLayerType InLayerType) { LayerType = InLayerType; }
    const TSubclassOf<UHLODBuilder> GetHLODBuilderClass() const { return HLODBuilderClass; }
    const UHLODBuilderSettings* GetHLODBuilderSettings() const { return HLODBuilderSettings; }
    const TSubclassOf<AWorldPartitionHLOD> GetHLODActorClass() const { return HLODActorClass; }
    const TSubclassOf<UWorldPartitionHLODModifier> GetHLODModifierClass() const { return HLODModifierClass; }
    UHLODLayer* GetParentLayer() const { return ParentLayer; }
    void SetParentLayer(UHLODLayer* InParentLayer) { ParentLayer = InParentLayer; }
    UHLODLayer* GetLinkedLayer() const { return LinkedLayer; }
    ENGINE_API bool DoesRequireWarmup() const;
    ENGINE_API void ComputeHLODHash(FHLODHashBuilder& InHLODHashBuilder) const;
 
    UE_DEPRECATED(5.7, "Deprecated. These streaming grid properties are now specified in the partition's settings.")
    ENGINE_API FName GetRuntimeGrid(uint32 InHLODLevel) const;
    UE_DEPRECATED(5.7, "Deprecated. These streaming grid properties are now specified in the partition's settings.")
    bool IsSpatiallyLoaded() const { return bIsSpatiallyLoaded; }
    UE_DEPRECATED(5.7, "Deprecated. These streaming grid properties are now specified in the partition's settings.")
    void SetIsSpatiallyLoaded(bool bInIsSpatiallyLoaded) { bIsSpatiallyLoaded = bInIsSpatiallyLoaded; }
    UE_DEPRECATED(5.7, "Deprecated. These streaming grid properties are now specified in the partition's settings.")
    int32 GetCellSize() const { return !bIsSpatiallyLoaded ? 0 : CellSize; }
    UE_DEPRECATED(5.7, "Deprecated. These streaming grid properties are now specified in the partition's settings.")
    double GetLoadingRange() const { return !bIsSpatiallyLoaded ? WORLD_MAX : LoadingRange; }
    UE_DEPRECATED(5.7, "Deprecated. These streaming grid properties are now specified in the partition's settings.")
    static ENGINE_API FName GetRuntimeGridName(uint32 InLODLevel, int32 InCellSize, double InLoadingRange);
 
    // Get name of properties
    static const FName GetLayerTypePropertyName() { return GET_MEMBER_NAME_CHECKED(UHLODLayer, LayerType); };
    static const FName GetHLODBuilderSettingsPropertyName() { return GET_MEMBER_NAME_CHECKED(UHLODLayer, HLODBuilderSettings); }
 
private:
    //~ Begin UObject Interface.
    ENGINE_API virtual void PostLoad() override;
#if WITH_EDITORONLY_DATA
    static ENGINE_API void DeclareConstructClasses(TArray<FTopLevelAssetPath>& OutConstructClasses, const UClass* SpecificSubclass);
#endif
    ENGINE_API virtual void PostEditChangeProperty(FPropertyChangedEvent& PropertyChangedEvent) override;
    virtual EDataValidationResult IsDataValid(class FDataValidationContext& Context) const override;
    //~ End UObject Interface.
#endif
 
#if WITH_EDITORONLY_DATA
private:
    UPROPERTY(EditAnywhere, Category=General)
    EHLODLayerType LayerType;
 
    UPROPERTY(EditAnywhere, Category=General, meta = (DisplayName = "HLOD Builder Class", EditConditionHides, EditCondition = "LayerType == EHLODLayerType::Custom"))
    TSubclassOf<UHLODBuilder> HLODBuilderClass;
 
    UPROPERTY(VisibleAnywhere, Instanced, NoClear, Category=General, meta = (NoResetToDefault, EditInline, ShowInnerProperties))
    TObjectPtr<UHLODBuilderSettings> HLODBuilderSettings;
 
    UPROPERTY(EditAnywhere, Category=General)
    uint32 bIsSpatiallyLoaded : 1;
 
    UPROPERTY(EditAnywhere, Category=General)
    int32 CellSize;
 
    UPROPERTY(EditAnywhere, Category=General)
    double LoadingRange;
 
    UPROPERTY(EditAnywhere, Category=General)
    TObjectPtr<UHLODLayer> ParentLayer;
    
    UPROPERTY(EditAnywhere, Category=General, AdvancedDisplay, meta = (EditConditionHides, EditCondition = "LayerType == EHLODLayerType::CustomHLODActor"))
    TObjectPtr<UHLODLayer> LinkedLayer;
 
    UPROPERTY(EditAnywhere, Category = General, AdvancedDisplay, meta = (DisplayName = "HLOD Actor Class"))
    TSubclassOf<AWorldPartitionHLOD> HLODActorClass;
 
    UPROPERTY(EditAnywhere, Category = General, AdvancedDisplay, meta = (DisplayName = "HLOD Modifier Class"))
    TSubclassOf<UWorldPartitionHLODModifier> HLODModifierClass;
 
    friend class FWorldPartitionHLODLayerDetailsCustomization;
 
private:
    friend class FWorldPartitionHLODUtilities;
 
    UPROPERTY()
    FMeshMergingSettings MeshMergeSettings_DEPRECATED;
    UPROPERTY()
    FMeshProxySettings MeshSimplifySettings_DEPRECATED;
    UPROPERTY()
    FMeshApproximationSettings MeshApproximationSettings_DEPRECATED;
    UPROPERTY()
    TSoftObjectPtr<UMaterialInterface> HLODMaterial_DEPRECATED;
    UPROPERTY()
    uint32 bAlwaysLoaded_DEPRECATED : 1;
#endif
};
 
 
#if UE_ENABLE_INCLUDE_ORDER_DEPRECATED_IN_5_5
#include "Engine/MeshMerging.h"
#endif