SubstrateVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
 
enum class FSubstrateViewMode : uint8
{
    None,
    MaterialProperties,
    MaterialCount,
    MaterialByteCount,
    SubstrateInfo,
    AdvancedMaterialProperties,
    MaterialClassification,
    RoughRefractionClassification,
    DecalClassification,
};
 
class FSubstrateVisualizationData
{
public:
 
    struct FModeRecord
    {
        FString   ModeString;
        FName     ModeName;
        FText     ModeText;
        FText     ModeDesc;
        FSubstrateViewMode ViewMode;
 
        // Whether or not this mode (by default) composites with regular scene depth.
        bool      bDefaultComposited;
 
        bool      bAvailableCommand;
        FText     UnavailableReason;
    };
 
    typedef TMultiMap<FName, FModeRecord> TModeMap;
 
public:
    FSubstrateVisualizationData()
    : bIsInitialized(false)
    {
    }
 
    void Initialize();
 
    inline bool IsInitialized() const { return bIsInitialized; }
 
    ENGINE_API FText GetModeDisplayName(const FName& InModeName) const;
 
    ENGINE_API FSubstrateViewMode GetViewMode(const FName& InModeName) const;
 
    ENGINE_API static uint32 GetViewMode();
 
    ENGINE_API bool GetModeDefaultComposited(const FName& InModeName) const;
 
    inline const TModeMap& GetModeMap() const
    {
        return ModeMap;
    }
 
    static const TCHAR* GetVisualizeConsoleCommandName()
    {
        return TEXT("r.Substrate.ViewMode");
    }
 
private:
 
    TModeMap ModeMap;
 
    FString ConsoleDocumentationVisualizationMode;
 
    bool bIsInitialized;
 
    IConsoleVariable* CVarViewModes = nullptr;
};
 
ENGINE_API FSubstrateVisualizationData& GetSubstrateVisualizationData();