FVirtualShadowMapVisualizationData Class Reference

#include <VirtualShadowMapVisualizationData.h>

Classes
struct	FModeRecord

Public Types
enum class	FModeType : uint8 { Standard , Advanced }
typedef TMap< FName, FModeRecord >	TModeMap

Public Member Functions
	FVirtualShadowMapVisualizationData ()
void	Initialize ()
bool	IsInitialized () const
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
const TModeMap &	GetModeMap () const
int32	GetActiveModeID () const
const FName &	GetActiveModeName () const

Static Public Member Functions
static const TCHAR *	GetVisualizeConsoleCommandName ()

Public Attributes
int	SelectAdjacentVisualizeLight = 0

Member Typedef Documentation

TModeMap

typedef TMap<FName, FModeRecord> FVirtualShadowMapVisualizationData::TModeMap

Mapping of FName to a visualization mode record.

Member Enumeration Documentation

FModeType

enum class FVirtualShadowMapVisualizationData::FModeType : uint8

strong

Enumerator
Standard
Advanced

Constructor & Destructor Documentation

FVirtualShadowMapVisualizationData()

FVirtualShadowMapVisualizationData::FVirtualShadowMapVisualizationData ( )

inline

Member Function Documentation

GetActiveModeID()

int32 FVirtualShadowMapVisualizationData::GetActiveModeID ( ) const

inline

GetActiveModeName()

const FName & FVirtualShadowMapVisualizationData::GetActiveModeName ( ) const

inline

GetModeDisplayName()

FText FVirtualShadowMapVisualizationData::GetModeDisplayName

(

const FName &

InModeName

)

const

Get the display name of a named mode from the available mode map.

GetModeID()

int32 FVirtualShadowMapVisualizationData::GetModeID

(

const FName &

InModeName

)

const

GetModeMap()

const TModeMap & FVirtualShadowMapVisualizationData::GetModeMap ( ) const

inline

GetViewModeIndexForVisualization()

EViewModeIndex FVirtualShadowMapVisualizationData::GetViewModeIndexForVisualization

(

const FName &

InModeName

)

const

GetVisualizeConsoleCommandName()

static const TCHAR * FVirtualShadowMapVisualizationData::GetVisualizeConsoleCommandName ( )

inlinestatic

Return the console command name for enabling single mode visualization.

Initialize()

void FVirtualShadowMapVisualizationData::Initialize

(

)

Initialize the system.

IsActive()

bool FVirtualShadowMapVisualizationData::IsActive

(

)

const

Check if visualization is active.

IsInitialized()

bool FVirtualShadowMapVisualizationData::IsInitialized ( ) const

inline

Check if system was initialized.

IsVSMViewMode()

bool FVirtualShadowMapVisualizationData::IsVSMViewMode

(

EViewModeIndex

ViewModeIndex

)

const

Update()

bool FVirtualShadowMapVisualizationData::Update

(

const FName &

InViewMode

)

Update state and check if visualization is active.

Member Data Documentation

SelectAdjacentVisualizeLight

int FVirtualShadowMapVisualizationData::SelectAdjacentVisualizeLight = 0

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Engine/Public/VirtualShadowMapVisualizationData.h
• Engine/Source/Runtime/Engine/Private/VirtualShadowMapVisualizationData.cpp