GroomVisualizationData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreMinimal.h"
#include "Async/Mutex.h"
 
class FSceneView;
 
enum class EGroomViewMode : uint8
{
    None,
    SimHairStrands,    // Guide
    RenderHairStrands, // Guide influence + add cluster
    UV,
    RootUV,
    RootUDIM,
    Seed,
    Dimension,
    RadiusVariation,
    Tangent,
    Color,
    Roughness,
    AO,
    ClumpID,
    Cluster,
    ClusterAABB,
    Group,
    LODColoration,
    ControlPoints,
    MacroGroups,
    LightBounds,
    DeepOpacityMaps,
    MacroGroupScreenRect,
    SamplePerPixel,
    CoverageType,
    TAAResolveType,
    VoxelsDensity,
    MeshProjection, // Rename RootBinding
    Coverage,
    MaterialDepth,
    MaterialBaseColor,
    MaterialRoughness,
    MaterialSpecular,
    MaterialTangent,
    CardGuides,
    Tile,
    Memory,
    Count
};
 
class FGroomVisualizationData
{
public:
    
    struct FModeRecord
    {
        FString        ModeString;
        FName          ModeName;
        FText          ModeText;
        FText          ModeDesc;
        EGroomViewMode Mode;
 
        // Whether or not this mode (by default) composites with regular scene depth.
        bool           DefaultComposited;
    };
 
    typedef TMultiMap<FName, FModeRecord> TModeMap;
 
public:
    FGroomVisualizationData()
    : bIsInitialized(false)
    {
    }
 
    void Initialize();
 
    inline bool IsInitialized() const { return bIsInitialized; }
 
    ENGINE_API FText GetModeDisplayName(const FName& InModeName) const;
 
    ENGINE_API EGroomViewMode GetViewMode(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.HairStrands.ViewMode");
    }
 
private:
 
    TModeMap ModeMap;
 
    FString ConsoleDocumentationVisualizationMode;
 
    std::atomic_bool bIsInitialized;
 
    UE::FMutex Mutex;
};
 
ENGINE_API FGroomVisualizationData& GetGroomVisualizationData();
ENGINE_API EGroomViewMode GetGroomViewMode(const FSceneView& View);
ENGINE_API const TCHAR* GetGroomViewModeName(EGroomViewMode In);
ENGINE_API bool IsGroomEnabled();
ENGINE_API void SetGroomEnabled(bool In);