LumenVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
class FLumenVisualizationData
{
public:
    enum class FModeType : uint8
    {
        Overview,
        Standard
    };
 
    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;
    };
 
    typedef TMultiMap<FName, FModeRecord> TModeMap;
 
public:
    FLumenVisualizationData()
    : bIsInitialized(false)
    {
    }
 
    void Initialize();
 
    inline bool IsInitialized() const { return bIsInitialized; }
 
    ENGINE_API bool IsActive() const;
 
    ENGINE_API FText GetModeDisplayName(const FName& InModeName) const;
 
    ENGINE_API int32 GetModeID(const FName& InModeName) const;
 
    ENGINE_API bool GetModeDefaultComposited(const FName& InModeName) const;
 
    inline const TModeMap& GetModeMap() const
    {
        return ModeMap;
    }
 
    static const TCHAR* GetVisualizeConsoleCommandName()
    {
        return TEXT("r.Lumen.Visualize.ViewMode");
    }
 
private:
    void ConfigureConsoleCommand();
 
    void AddVisualizationMode(
        const TCHAR* ModeString,
        const FText& ModeText,
        const FText& ModeDesc,
        const FModeType ModeType,
        int32 ModeID,
        bool DefaultComposited
    );
 
    void SetActiveMode(int32 ModeID, const FName& ModeName, bool bDefaultComposited);
 
private:
    TModeMap ModeMap;
 
    FString ConsoleDocumentationVisualizationMode;
 
    bool bIsInitialized;
};
 
ENGINE_API FLumenVisualizationData& GetLumenVisualizationData();