NaniteVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "VisualizationData/VisualizationDataShared.h"
 
class UWorld;
class FNaniteVisualizationData
{
public:
    enum class FModeType : uint8
    {
        Overview,
        Standard,
        Advanced,
    };
 
    struct FModeRecord
    {
        FString   ModeString;
        FName     ModeName;
        FText     ModeText;
        FText     ModeDesc;
        FModeType ModeType;
        int32     ModeID;
 
        // Whether or not this mode (by default) composites with regular scene depth.
        bool      DefaultComposited;
        bool      bDrawLegend;
        TArray<FVisualizationDataLegendEntry> LegendEntries;
    };
 
    typedef TMultiMap<FName, FModeRecord> TModeMap;
 
public:
    FNaniteVisualizationData()
    : bIsInitialized(false)
    {
    }
 
    void Initialize();
 
    inline bool IsInitialized() const { return bIsInitialized; }
 
    ENGINE_API bool IsActive() const;
 
    ENGINE_API bool Update(const FName& InViewMode);
 
    ENGINE_API FText GetModeDisplayName(const FName& InModeName) const;
 
    ENGINE_API int32 GetModeID(const FName& InModeName) const;
 
    ENGINE_API bool GetModeDefaultComposited(const FName& InModeName) const;
 
    ENGINE_API bool ShouldDrawLegend(const FName& InModeName) const;
    ENGINE_API TArray<FVisualizationDataLegendEntry> GetLegendEntries(const FName& InModeName) const;
 
    void SetCurrentOverviewModeList(const FString& InNameList);
    bool IsDifferentToCurrentOverviewModeList(const FString& InNameList);
 
    inline int32 GetActiveModeID() const
    {
        return ActiveVisualizationModeID;
    }
 
    inline const FName& GetActiveModeName() const
    {
        return ActiveVisualizationModeName;
    }
 
    inline bool GetActiveModeDefaultComposited() const
    {
        return bActiveVisualizationModeComposited;
    }
 
    inline const TArray<FName, TInlineAllocator<32>>& GetOverviewModeNames() const
    {
        return CurrentOverviewModeNames;
    }
 
    inline const TArray<int32, TInlineAllocator<32>>& GetOverviewModeIDs() const
    {
        return CurrentOverviewModeIDs;
    }
 
    inline const TModeMap& GetModeMap() const
    {
        return ModeMap;
    }
 
    static const TCHAR* GetVisualizeConsoleCommandName()
    {
        return TEXT("r.Nanite.Visualize");
    }
 
    static const TCHAR* GetOverviewConsoleCommandName()
    {
        return TEXT("r.Nanite.VisualizeOverview");
    }
 
    ENGINE_API void Pick(UWorld* World);
 
    inline const FVector2f& GetPickingMousePos() const
    {
        return MousePos;
    }
 
    inline const FIntPoint& GetPickingScreenSize() const
    {
        return ScreenSize;
    }
 
private:
    void ConfigureConsoleCommand();
 
    void AddVisualizationMode(
        const TCHAR* ModeString,
        const FText& ModeText,
        const FModeType ModeType,
        int32 ModeID,
        bool DefaultComposited,
        bool bDrawLegend = true,
        TArray<FVisualizationDataLegendEntry>&& LegendEntries = TArray<FVisualizationDataLegendEntry>()
    );
 
    void SetActiveMode(int32 ModeID, const FName& ModeName, bool bDefaultComposited);
 
private:
    TModeMap ModeMap;
 
    int32 ActiveVisualizationModeID = INDEX_NONE;
    FName ActiveVisualizationModeName = NAME_None;
    bool bActiveVisualizationModeComposited = true;
 
    FString CurrentOverviewModeList;
 
    TArray<FName, TInlineAllocator<32>> CurrentOverviewModeNames;
    TArray<int32, TInlineAllocator<32>> CurrentOverviewModeIDs;
    bool bOverviewListEmpty = true;
 
    FString CurrentConsoleVisualizationMode;
    
    FString ConsoleDocumentationVisualizationMode;
    FString ConsoleDocumentationOverviewTargets;
 
    FVector2f MousePos;
    FIntPoint ScreenSize;
 
    bool bIsInitialized;
};
 
ENGINE_API FNaniteVisualizationData& GetNaniteVisualizationData();