Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FNaniteVisualizationData |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/NaniteVisualizationData.h |
| Include Path | #include "NaniteVisualizationData.h" |
Syntax
class FNaniteVisualizationData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FNaniteVisualizationData() |
NaniteVisualizationData.h |
Structs
| Name | Remarks |
|---|---|
| FModeRecord | Describes a single available visualization mode. |
Enums
Public
| Name | Remarks |
|---|---|
| FModeType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TModeMap | TMultiMap< FName, FModeRecord > | Mapping of FName to a visualization mode record. | NaniteVisualizationData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveVisualizationModeID | int32 | NaniteVisualizationData.h | ||
| ActiveVisualizationModeName | FName | NaniteVisualizationData.h | ||
| bActiveVisualizationModeComposited | bool | NaniteVisualizationData.h | ||
| bIsInitialized | bool | Flag indicating if system is initialized. | NaniteVisualizationData.h | |
| bOverviewListEmpty | bool | NaniteVisualizationData.h | ||
| ConsoleDocumentationOverviewTargets | FString | NaniteVisualizationData.h | ||
| ConsoleDocumentationVisualizationMode | FString | Storage for console variable documentation strings. | NaniteVisualizationData.h | |
| CurrentConsoleVisualizationMode | FString | Current visualization mode name set from command console | NaniteVisualizationData.h | |
| CurrentOverviewModeIDs | TArray< int32, TInlineAllocator< 32 > > | NaniteVisualizationData.h | ||
| CurrentOverviewModeList | FString | List of modes names to use in the Nanite visualization overview. | NaniteVisualizationData.h | |
| CurrentOverviewModeNames | TArray< FName, TInlineAllocator< 32 > > | Tokenized Nanite visualization mode names. | NaniteVisualizationData.h | |
| ModeMap | TModeMap | The name->mode mapping table | NaniteVisualizationData.h | |
| MousePos | FVector2f | Mouse picking information | NaniteVisualizationData.h | |
| ScreenSize | FIntPoint | NaniteVisualizationData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetActiveModeDefaultComposited() |
NaniteVisualizationData.h | ||
int32 GetActiveModeID() |
NaniteVisualizationData.h | ||
const FName & GetActiveModeName() |
NaniteVisualizationData.h | ||
TArray< FVisualizationDataLegendEntry > GetLegendEntries
(
const FName& InModeName |
NaniteVisualizationData.h | ||
bool GetModeDefaultComposited
(
const FName& InModeName |
NaniteVisualizationData.h | ||
| Get the display name of a named mode from the available mode map. | NaniteVisualizationData.h | ||
int32 GetModeID
(
const FName& InModeName |
NaniteVisualizationData.h | ||
const TModeMap & GetModeMap() |
NaniteVisualizationData.h | ||
const TArray< int32, TInlineAllocator< 32 > > & GetOverviewModeIDs() |
NaniteVisualizationData.h | ||
| Access the list of modes currently in use by the Nanite visualization overview. | NaniteVisualizationData.h | ||
const FVector2f & GetPickingMousePos() |
NaniteVisualizationData.h | ||
const FIntPoint & GetPickingScreenSize() |
NaniteVisualizationData.h | ||
void Initialize() |
Initialize the system. | NaniteVisualizationData.h | |
bool IsActive() |
Check if visualization is active. | NaniteVisualizationData.h | |
bool IsDifferentToCurrentOverviewModeList
(
const FString& InNameList |
NaniteVisualizationData.h | ||
bool IsInitialized() |
Check if system was initialized. | NaniteVisualizationData.h | |
void Pick
(
UWorld* World |
NaniteVisualizationData.h | ||
void 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. | NaniteVisualizationData.h | |
bool ShouldDrawLegend
(
const FName& InModeName |
NaniteVisualizationData.h | ||
bool Update
(
const FName& InViewMode |
Update state and check if visualization is active. | NaniteVisualizationData.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR * GetOverviewConsoleCommandName() |
Return the console command name for enabling multi mode visualization. | NaniteVisualizationData.h | |
static const TCHAR * GetVisualizeConsoleCommandName() |
Return the console command name for enabling single mode visualization. | NaniteVisualizationData.h |