Navigation
API > API/Plugins > API/Plugins/ChaosVD
Main module class for the Chaos Visual Debugger editor
| Name | FChaosVDModule |
| Type | class |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/ChaosVDModule.h |
| Include Path | #include "ChaosVDModule.h" |
Syntax
class FChaosVDModule : public IModuleInterface
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ToolkitHostType | SChaosVDMainTab | ChaosVDModule.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ChaosVisualDebuggerProgramName | FString | ChaosVDModule.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveChaosVDInstances | TMap< FGuid, TSharedPtr< FChaosVDEngine > > | ChaosVDModule.h | ||
| ActiveCVDTabs | TMap< FGuid, TWeakPtr< SDockTab > > | ChaosVDModule.h | ||
| bIsShuttingDown | bool | ChaosVDModule.h | ||
| ChaosVDTraceManager | TSharedPtr< FChaosVDTraceManager > | ChaosVDModule.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TSharedPtr< FChaosVDTraceManager > & GetTraceManager() |
Returns the Trace manager instance used by CVD | ChaosVDModule.h | |
void ReloadInstanceUI
(
FGuid InstanceGUID |
Re-instantiates CVD's widgets without restarting the underlying CVD engine instance | ChaosVDModule.h | |
void SpawnCVDTab() |
Spawns a new instance of CVD | ChaosVDModule.h |
Overridden from IModuleInterface
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void ShutdownModule() |
ChaosVDModule.h | ||
virtual void StartupModule() |
IModuleInterface implementation | ChaosVDModule.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FChaosVDModule & Get() |
ChaosVDModule.h | ||
static bool IsStandaloneChaosVisualDebugger() |
ChaosVDModule.h |