IWorldPartitionEditorModule.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
#pragma once
 
#include "CoreMinimal.h"
#include "Modules/ModuleInterface.h"
#include "Templates/SubclassOf.h"
 
class UWorldPartitionBuilder;
 
class IWorldPartitionEditorModule : public IModuleInterface
{
public:
    virtual ~IWorldPartitionEditorModule() {}
 
    static ENGINE_API IWorldPartitionEditorModule& Get();
 
    virtual bool ConvertMap(const FString& InLongPackageName) = 0;
 
    UE_DEPRECATED(5.1, "Use RunBuilder with UWorld* instead.")
    virtual bool RunBuilder(TSubclassOf<UWorldPartitionBuilder> BuilderClass, const FString& InLongPackageName) { return false; }
        
    struct FRunBuilderParams
    {
        TSubclassOf<UWorldPartitionBuilder> BuilderClass;
        UWorld* World = nullptr;
        FString ExtraArgs;
        FText OperationDescription;
    };
 
    virtual bool RunBuilder(TSubclassOf<UWorldPartitionBuilder> BuilderClass, UWorld* InWorld);
    virtual bool RunBuilder(const FRunBuilderParams& Params) = 0;
 
    virtual int32 GetPlacementGridSize() const = 0;
    virtual int32 GetInstancedFoliageGridSize() const = 0;
    virtual int32 GetMinimapLowQualityWorldUnitsPerPixelThreshold() const = 0;
    
    virtual bool GetEnableLoadingInEditor() const = 0;
    virtual void SetEnableLoadingInEditor(bool bInEnableLoadingInEditor) = 0;
 
    virtual bool GetEnableStreamingGenerationLogOnPIE() const = 0;
    virtual void SetEnableStreamingGenerationLogOnPIE(bool bInEnableLoadingInEditor) = 0;
 
    virtual bool GetDisablePIE() const = 0;
    virtual void SetDisablePIE(bool bInDisablePIE) = 0;
 
    virtual bool GetDisableBugIt() const = 0;
    virtual void SetDisableBugIt(bool bInDisableBugIt) = 0;
 
    virtual bool GetAdvancedMode() const = 0;
    virtual void SetAdvancedMode(bool bInAdvancedMode) = 0;
 
    virtual bool GetRequireExplicitHLODLayerPartitionAssignation() const = 0;
    virtual void SetRequireExplicitHLODLayerPartitionAssignation(bool bInRequireExplicitHLODLayerPartitionAssignation) = 0;
 
    virtual bool IsEditingContentBundle() const = 0;
    virtual bool IsEditingContentBundle(const FGuid& ContentBundleGuid) const = 0;
 
    virtual bool GetShowHLODsInEditor() const = 0;
    virtual void SetShowHLODsInEditor(bool bInShowHLODsInEditor) = 0;
 
    virtual bool GetShowHLODsOverLoadedRegions() const = 0;
    virtual void SetShowHLODsOverLoadedRegions(bool bInShowHLODsOverLoadedRegions) = 0;
 
    virtual double GetHLODInEditorMinDrawDistance() const = 0;
    virtual void SetHLODInEditorMinDrawDistance(double InMinDrawDistance) = 0;
 
    virtual double GetHLODInEditorMaxDrawDistance() const = 0;
    virtual void SetHLODInEditorMaxDrawDistance(double InMaxDrawDistance) = 0;
 
    virtual bool IsHLODInEditorAllowed(UWorld* InWorld, FText* OutDisallowedReason = nullptr) const = 0;
 
    virtual bool HasErrors(UWorld* World) const = 0;
 
    virtual void RepairErrors(UWorld* World) = 0;
 
    struct FWriteHLODStatsParams
    {
        enum class EStatsType : uint8
        {
            Default,
            InputDetails
        };
 
        UWorld* World = nullptr;
        FString Filename;
        EStatsType StatsType = EStatsType::Default;
    };
 
    virtual bool WriteHLODStats(const FWriteHLODStatsParams& Params) const = 0;
 
    DECLARE_EVENT_OneParam(IWorldPartitionEditorModule, FWorldPartitionCreated, UWorld*);
 
    DECLARE_EVENT_OneParam(IWorldPartitionEditorModule, FOnPreExecuteCommandlet, FRunBuilderParams&);
 
    DECLARE_EVENT_OneParam(IWorldPartitionEditorModule, FOnExecuteCommandlet, TArray<FString>&);
 
    DECLARE_EVENT(IWorldPartitionEditorModule, FOnPostExecuteCommandlet);
 
    virtual FWorldPartitionCreated& OnWorldPartitionCreated() = 0;
 
    virtual FOnPreExecuteCommandlet& OnPreExecuteCommandlet() = 0;
 
    virtual FOnExecuteCommandlet& OnExecuteCommandlet() = 0;
 
    virtual FOnPostExecuteCommandlet& OnPostExecuteCommandlet() = 0;
};