FNaniteVisualizationData Class Reference

#include <NaniteVisualizationData.h>

Classes
struct	FModeRecord

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

Public Member Functions
	FNaniteVisualizationData ()
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 int32	GetModeID (const FName &InModeName) const
ENGINE_API bool	GetModeDefaultComposited (const FName &InModeName) const
ENGINE_API bool	ShouldDrawLegend (const FName &InModeName) const
ENGINE_API TArray< FVisualizationDataLegendEntry >	GetLegendEntries (const FName &InModeName) const
void	SetCurrentOverviewModeList (const FString &InNameList)
bool	IsDifferentToCurrentOverviewModeList (const FString &InNameList)
int32	GetActiveModeID () const
const FName &	GetActiveModeName () const
bool	GetActiveModeDefaultComposited () const
const TArray< FName, TInlineAllocator< 32 > > &	GetOverviewModeNames () const
const TArray< int32, TInlineAllocator< 32 > > &	GetOverviewModeIDs () const
const TModeMap &	GetModeMap () const
ENGINE_API void	Pick (UWorld *World)
const FVector2f &	GetPickingMousePos () const
const FIntPoint &	GetPickingScreenSize () const

Static Public Member Functions
static const TCHAR *	GetVisualizeConsoleCommandName ()
static const TCHAR *	GetOverviewConsoleCommandName ()

Member Typedef Documentation

TModeMap

typedef TMultiMap<FName, FModeRecord> FNaniteVisualizationData::TModeMap

Mapping of FName to a visualization mode record.

Member Enumeration Documentation

FModeType

enum class FNaniteVisualizationData::FModeType : uint8

strong

Enumerator
Overview
Standard
Advanced

Constructor & Destructor Documentation

FNaniteVisualizationData()

FNaniteVisualizationData::FNaniteVisualizationData ( )

inline

Member Function Documentation

GetActiveModeDefaultComposited()

bool FNaniteVisualizationData::GetActiveModeDefaultComposited ( ) const

inline

GetActiveModeID()

int32 FNaniteVisualizationData::GetActiveModeID ( ) const

inline

GetActiveModeName()

const FName & FNaniteVisualizationData::GetActiveModeName ( ) const

inline

GetLegendEntries()

TArray< FVisualizationDataLegendEntry > FNaniteVisualizationData::GetLegendEntries

(

const FName &

InModeName

)

const

GetModeDefaultComposited()

bool FNaniteVisualizationData::GetModeDefaultComposited

(

const FName &

InModeName

)

const

GetModeDisplayName()

FText FNaniteVisualizationData::GetModeDisplayName

(

const FName &

InModeName

)

const

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

GetModeID()

int32 FNaniteVisualizationData::GetModeID

(

const FName &

InModeName

)

const

GetModeMap()

const TModeMap & FNaniteVisualizationData::GetModeMap ( ) const

inline

GetOverviewConsoleCommandName()

static const TCHAR * FNaniteVisualizationData::GetOverviewConsoleCommandName ( )

inlinestatic

Return the console command name for enabling multi mode visualization.

GetOverviewModeIDs()

const TArray< int32, TInlineAllocator< 32 > > & FNaniteVisualizationData::GetOverviewModeIDs ( ) const

inline

GetOverviewModeNames()

const TArray< FName, TInlineAllocator< 32 > > & FNaniteVisualizationData::GetOverviewModeNames ( ) const

inline

Access the list of modes currently in use by the Nanite visualization overview.

GetPickingMousePos()

const FVector2f & FNaniteVisualizationData::GetPickingMousePos ( ) const

inline

GetPickingScreenSize()

const FIntPoint & FNaniteVisualizationData::GetPickingScreenSize ( ) const

inline

GetVisualizeConsoleCommandName()

static const TCHAR * FNaniteVisualizationData::GetVisualizeConsoleCommandName ( )

inlinestatic

Return the console command name for enabling single mode visualization.

Initialize()

void FNaniteVisualizationData::Initialize

(

)

Initialize the system.

IsActive()

bool FNaniteVisualizationData::IsActive

(

)

const

Check if visualization is active.

IsDifferentToCurrentOverviewModeList()

bool FNaniteVisualizationData::IsDifferentToCurrentOverviewModeList

(

const FString &

InNameList

)

IsInitialized()

bool FNaniteVisualizationData::IsInitialized ( ) const

inline

Check if system was initialized.

Pick()

void FNaniteVisualizationData::Pick

(

UWorld *

World

)

SetCurrentOverviewModeList()

void FNaniteVisualizationData::SetCurrentOverviewModeList

(

const FString &

InNameList

)

We cache the overview mode name list from the console command here, so all dynamically created views can re-use the existing cached list of modes.

ShouldDrawLegend()

bool FNaniteVisualizationData::ShouldDrawLegend

(

const FName &

InModeName

)

const

Update()

bool FNaniteVisualizationData::Update

(

const FName &

InViewMode

)

Update state and check if visualization is active.

---

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

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