Navigation
API > API/Runtime > API/Runtime/Engine
| Name | FGroomVisualizationData |
| Type | class |
| Header File | /Engine/Source/Runtime/Engine/Public/GroomVisualizationData.h |
| Include Path | #include "GroomVisualizationData.h" |
Syntax
class FGroomVisualizationData
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FGroomVisualizationData() |
GroomVisualizationData.h |
Structs
| Name | Remarks |
|---|---|
| FModeRecord | Describes a single available visualization mode. |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| TModeMap | TMultiMap< FName, FModeRecord > | Mapping of FName to a visualization mode record. | GroomVisualizationData.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bIsInitialized | std::atomic_bool | Flag indicating if system is initialized. | GroomVisualizationData.h | |
| ConsoleDocumentationVisualizationMode | FString | Storage for console variable documentation strings. | GroomVisualizationData.h | |
| ModeMap | TModeMap | The name->mode mapping table | GroomVisualizationData.h | |
| Mutex | UE::FMutex | Mutex for initialization. | GroomVisualizationData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool GetModeDefaultComposited
(
const FName& InModeName |
GroomVisualizationData.h | ||
| Get the display name of a named mode from the available mode map. | GroomVisualizationData.h | ||
const TModeMap & GetModeMap() |
GroomVisualizationData.h | ||
EGroomViewMode GetViewMode
(
const FName& InModeName |
GroomVisualizationData.h | ||
void Initialize() |
Initialize the system. | GroomVisualizationData.h | |
bool IsInitialized() |
Check if system was initialized. | GroomVisualizationData.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR * GetVisualizeConsoleCommandName() |
Return the console command name for enabling single mode visualization. | GroomVisualizationData.h |