VirtualShadowMapVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Engine/EngineBaseTypes.h"
 
class FVirtualShadowMapVisualizationData
{
public:
    enum class FModeType : uint8
    {
        Standard,
        Advanced,
    };
 
    struct FModeRecord
    {
        FString        ModeString;
        FName          ModeName;
        FText          ModeText;
        FText          ModeDesc;
        FModeType      ModeType;
        int32          ModeID;
        EViewModeIndex ViewModeIndex;
    };
 
    typedef TMap<FName, FModeRecord> TModeMap;
 
public:
    FVirtualShadowMapVisualizationData()
    : 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 EViewModeIndex GetViewModeIndexForVisualization(const FName& InModeName) const;
 
    ENGINE_API bool IsVSMViewMode(EViewModeIndex ViewModeIndex) const;
 
    ENGINE_API int32 GetModeID(const FName& InModeName) const;
 
    inline const TModeMap& GetModeMap() const
    {
        return ModeMap;
    }
 
    inline int32 GetActiveModeID() const
    {
        return ActiveVisualizationModeID;
    }
 
    inline const FName& GetActiveModeName() const
    {
        return ActiveVisualizationModeName;
    }
 
    static const TCHAR* GetVisualizeConsoleCommandName()
    {
        return TEXT("r.Shadow.Virtual.Visualize");
    }
 
    int SelectAdjacentVisualizeLight = 0;
 
private:
    void ConfigureConsoleCommand();
 
    void AddVisualizationMode(
        const TCHAR* ModeString,
        const FText& ModeText,
        const FText& ModeDesc,
        const FModeType ModeType,
        int32 ModeID,
        EViewModeIndex ViewModeIndex = VMI_VisualizeVirtualShadowMap
    );
 
    void SetActiveMode(int32 ModeID, const FName& ModeName);
 
private:
    TModeMap ModeMap;
 
    int32 ActiveVisualizationModeID = INDEX_NONE;
    FName ActiveVisualizationModeName = NAME_None;
 
    FString ConsoleDocumentationVisualizationMode;
 
    bool bIsInitialized;
};
 
ENGINE_API FVirtualShadowMapVisualizationData& GetVirtualShadowMapVisualizationData();