Navigation
| Name | ChaosVD |
| Type | Plugin |
| Part of Plugins | Chaos Visual Debugger |
| Location | /Engine/Plugins/ChaosVD/Source/ChaosVD/ |
| Module Build Rules | ChaosVD.Build.cs |
Classes
| Name | Remarks |
|---|---|
| AChaosVDDataContainerBaseActor | Base class for any CVD actor that will contain frame related data (either solver frame or game frame) |
| FChaosVDComponentVisualizerBase | Base class used for all component visualizers in CVD - It provides a common code to handle selection and clicks |
| FChaosVDDataProcessorBase | Abstract base class that should be used for any class that is able to process traced Chaos Visual Debugger binary data |
| FChaosVDDebugDrawUtils | Utility methods that allows Debug draw into the Chaos VD Editor |
| FChaosVDEngine | Core Implementation of the visual debugger - Owns the systems that are not UI |
| FChaosVDExtension | Base class for any CVD Extension. |
| FChaosVDExtensionsManager | Manager class where all CVD extensions are registered to |
| FChaosVDGenericDataProcessor | |
| FChaosVDGeometryBuilder | Generates Dynamic mesh components and dynamic meshes based on Chaos implicit object data |
| FChaosVDGeometryComponentUtils | |
| FChaosVDGeometryGenerationTask | Used to execute each individual Geometry Generation task using the data with which was constructed. |
| FChaosVDInstancedMeshData | Structure that represents a specific mesh instance on a CVD Mesh component (instanced or static) |
| FChaosVDModule | Main module class for the Chaos Visual Debugger editor |
| FChaosVDObjectDetailsTab | Spawns and handles an instance for the visual debugger details panel |
| FChaosVDParticleDataComponentVisualizer | Component visualizer in charge of generating debug draw visualizations for for particles |
| FChaosVDPlaybackController | Loads,unloads and owns a Chaos VD recording file |
| FChaosVDScene | Recreates a UWorld from a recorded Chaos VD Frame |
| FChaosVDSceneSelectionObserver | Base class that provided access to selection events from the Chaos visual debugger local selection system. |
| FChaosVDSceneStreaming | Simple pseudo level streaming system that works with a collection of ChaosVDSceneObjects - This system only updates a desired streaming state (from multiple threads) and issues a sync request in the GT. |
| FChaosVDSettingsManager | Manager class that handles all available CVD settings objects |
| FChaosVDSolverDataSelection | Generic Solver Data selection system. The data this selection system can use must be UStructs |
| FChaosVDStandAloneObjectDetailsTab | Spawns and handles an instance for a selection independent details panel |
| FChaosVDStyle | |
| FChaosVDTabID | Built-in CVD tab IDs |
| FChaosVDTabSpawnerBase | Base class for any tab of the Chaos Visual Debugger tool |
| FChaosVDTraceManager | Manager class used by Chaos VD to interact/control UE Trace systems |
| FChaosVDTraceManagerThreadContext | Objects that allows us to use TLS to temporarily store and access a ptr to an existing instance. |
| FChaosVDTraceProvider | Provider class for Chaos VD trace recordings. |
| FChaosVDTrimeshBVHVisualizer | |
| FRelayDataStream | A trace data stream object that listens for data coming from a relay stream via CVD's Engine Editor Bridge object |
| SChaosVDDetailsView | Simple details for CVD objects and structures |
| SChaosVDEnumFlagsMenu | |
| SChaosVDMainTab | The main widget containing the Chaos Visual Debugger interface |
| UChaosVDCharacterGroundConstraintDataProviderInterface | This class does not need to be modified. |
| UChaosVDCoreSettings | Core settings class for CVD |
| UChaosVDGeometryComponent | |
| UChaosVDMainToolbarMenuContext | |
| UChaosVDParticleDataComponent | Component that references all particle data for a specific solver for the current frame, and handles how the visualization is updated based on that data |
| UChaosVDPooledObject | |
| UChaosVDSelectableObject | |
| UChaosVDSelectionInterface | CVD Custom Selection Interface. We don't have any specific implementation overrides yet |
| UChaosVDSettingsObjectBase | Base class to be used by any CVD settings. |
| UChaosVDSettingsObjectsOuter | |
| UChaosVDSolverDataComponent | Base class for all components that stores recorded solver data |
| UChaosVDVisualizationSettingsObjectBase | Base class to be used by any CVD settings related to visualization. |
Structs
| Name | Remarks |
|---|---|
| FAsyncProgressNotification | Object that allows showing a progress bar in the status bar of the editor, where the progress can be updated from any thread |
| FChaosVDBaseSceneObject | Base Class for any UStruct based object that has a representation in CVD's World and outliner |
| FChaosVDExtractedGeometryDataHandle | Structure that acts as a handle to access the generated static mesh of a implicit object, plus other data extracted from it |
| FChaosVDFrameIndexTestData | |
| FChaosVDGeometryDataUpdate | |
| FChaosVDImplicitObjectBasicView | Struct holding the a minimum amount of data about a Implicit object to be shown in the details panel |
| FChaosVDMeshDataInstanceState | Struct holding the state of a mesh instance - Is separated from the Mesh instance class so we can show the data in the Details panel |
| FChaosVDParticleDataVisualizationContext | |
| FChaosVDPlaybackEngineSnapshot | Structure containing data about the playback engine state at the time when this struct is created. |
| FChaosVDQueuedTrackInfoUpdate | |
| FChaosVDSceneCompositionTestData | Structure containing data about how a CVD scene is composed. |
| FChaosVDSceneParticle | |
| FChaosVDSelectionContext | Base struct type used for any context data we want to add for a selection handle |
| FChaosVDSelectionMultipleView | Struct used to create a combined view of multiple structs to be used in a vanilla details panel. |
| FChaosVDSolverDataSelectionHandle | Selection handle that holds a reference to the selected solver data |
| FChaosVDTraceSessionDescriptor | Structure containing info about a trace session used by Chaos Visual Debugger |
| FChaosVDTrackInfo | Data that represents the current state of a track and ID info |
| FChaosVDVisualizationContext | Context needed to be able to visualize data in the viewport |
| FStructTypedElementData | |
| HChaosVDComponentVisProxy | Custom Hit Proxy for debug drawn particle data |
Interfaces
| Name | Remarks |
|---|---|
| IChaosVDCharacterGroundConstraintDataProviderInterface | Interface for any object that is able to provide CVD Character Ground Constraint Data |
| IChaosVDGeometryComponent | Interface with a default implementation for any Geometry component that contains CVD data |
| IChaosVDPooledObject | Interface used by any object that can be pooled |
| IChaosVDSelectableObject | Interface used for any object that can be selected in CVD and need to process selection events performed on it. |
| IChaosVDStreamingDataSource |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FChaosVDFocusRequestDelegate | TMulticastDelegate_OneParam< void, FBox > | ChaosVDScene.h | |
| FChaosVDMeshComponentEmptyDelegate | TMulticastDelegate_OneParam< void, UMeshComponent * > | ChaosVDGeometryDataComponent.h | |
| FChaosVDMeshReadyDelegate | TMulticastDelegate_OneParam< void, IChaosVDGeometryComponent & > | ChaosVDGeometryDataComponent.h | |
| FChaosVDOnObjectSelectedDelegate | TMulticastDelegate_OneParam< void, UObject * > | ChaosVDScene.h | |
| FChaosVDPlaybackControllerFrameUpdated | TMulticastDelegate_ThreeParams< void, TWeakPtr< FChaosVDPlaybackController >, TWeakPtr< const FChaosVDTrackInfo >, FGuid > | ChaosVDPlaybackController.h | |
| FChaosVDPlaybackControllerUpdated | TMulticastDelegate_OneParam< void, TWeakPtr< FChaosVDPlaybackController > > | ChaosVDPlaybackController.h | |
| FChaosVDSceneUpdatedDelegate | TMulticastDelegate_NoParams< void > | ChaosVDScene.h | |
| FChaosVDSettingChanged | TMulticastDelegate_OneParam< void, UObject *SettingsObject > | Settings/ChaosVDCoreSettings.h | |
| FChaosVDSolverDataSelectionChangedDelegate | TMulticastDelegate_OneParam< void, const TSharedPtr< FChaosVDSolverDataSelectionHandle > &SelectionHandle > | ChaosVDSolverDataSelection.h | |
| FChaosVDSolverInfoActorCreatedDelegate | TMulticastDelegate_OneParam< void, AChaosVDSolverInfoActor * > | ChaosVDScene.h | |
| FChaosVDSolverInfoByIDMap | TMap< int32, AChaosVDSolverInfoActor * > | ChaosVDScene.h | |
| FChaosVDSolverVisibilityChangedDelegate | TMulticastDelegate_TwoParams< void, int32 SolverID, bool bNewVisibility > | ChaosVDScene.h | |
| FChaosVDTabDestroyed | TMulticastDelegate_OneParam< void, TSharedRef< SDockTab > > | ChaosVDTabSpawnerBase.h | |
| FChaosVDTabSpawned | TMulticastDelegate_OneParam< void, TSharedRef< SDockTab > > | ChaosVDTabSpawnerBase.h | |
| FExtractedGeometryHandle | TSharedPtr< FChaosVDExtractedGeometryDataHandle > | ChaosVDGeometryBuilder.h | |
| FMeshComponentWeakPtr | TWeakObjectPtr< UMeshComponent > | ChaosVDGeometryBuilder.h | |
| FSessionStateChangedDelegate | TMulticastDelegate_OneParam< void, const FChaosVDTraceSessionDescriptor &InSessionDescriptor > | ChaosVDEngine.h | |
| TrackInfoByIDMap | TMap< int32, TSharedPtr< FChaosVDTrackInfo > > | ChaosVDPlaybackController.h |
Enums
Public
| Name | Remarks |
|---|---|
| EChaosVDActorGeometryUpdateFlags | Options flags to control how geometry is updated in a ChaosVDActor |
| EChaosVDDebugDrawTextLocationMode | |
| EChaosVDGeometryTransformGeneratorFlags | Set of flags used to control how we generate a transform from implicit object data |
| EChaosVDHideParticleFlags | |
| EChaosVDLoadRecordedDataMode | Enumeration of the available modes controlling how data is loaded into CVD |
| EChaosVDMaterialType | |
| EChaosVDMeshAttributesFlags | |
| EChaosVDMeshComponent | |
| EChaosVDParticleVisibilityUpdateFlags | |
| EChaosVDSceneCleanUpOptions | |
| EChaosVDSceneParticleDirtyFlags | Set of flags used to indicate which data was modified and needs to be evaluated again by other systems |
| EChaosVDSolverStageAccessorFlags | Set of flags that control how a solver stage is accessed |
| EChaosVDStreamingDirtyFlags | |
| EChaosVDSyncTimelinesMode | Available sync modes that determine how tracks will sync between each other during playback |
| EChaosVDTrackType | Enum with the available game track types |
| EChaosVDUnloadRecordingFlags | Flags used to control how the unload of a recording is performed |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Chaos::VD::TypedElementDataUtil::NAME_CVD_StructDataElement | const FName | TEDS/ChaosVDStructTypedElementData.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FTypedElementHandle Chaos::VD::TypedElementDataUtil::AcquireTypedElementHandleForStruct
(
StructDataType* ElementInstance, |
TEDS/ChaosVDStructTypedElementData.h | ||
TTypedElementOwner< FStructTypedElementData > Chaos::VD::TypedElementDataUtil::CreateTypedElementDataForStructData
(
StructDataType* InElementData |
TEDS/ChaosVDStructTypedElementData.h | ||
StructDataType * Chaos::VD::TypedElementDataUtil::GetStructDataFromTypedElementHandle
(
const FTypedElementHandle& InHandle, |
TEDS/ChaosVDStructTypedElementData.h | ||
bool operator!
(
EChaosVDGeometryTransformGeneratorFlags E |
ChaosVDGeometryBuilder.h | ||
bool operator!
(
EChaosVDMeshAttributesFlags E |
ChaosVDGeometryDataComponent.h | ||
bool operator!
(
EChaosVDUnloadRecordingFlags E |
ChaosVDPlaybackController.h | ||
bool operator!
(
EChaosVDSceneCleanUpOptions E |
ChaosVDScene.h | ||
bool operator!
(
EChaosVDParticleVisibilityUpdateFlags E |
ChaosVDSceneParticle.h | ||
bool operator!
(
EChaosVDActorGeometryUpdateFlags E |
ChaosVDSceneParticleFlags.h | ||
bool operator!
(
EChaosVDHideParticleFlags E |
ChaosVDSceneParticleFlags.h | ||
bool operator!
(
EChaosVDSceneParticleDirtyFlags E |
ChaosVDSceneParticleFlags.h | ||
bool operator!
(
EChaosVDStreamingDirtyFlags E |
ChaosVDSceneStreaming.h | ||
bool operator!
(
EChaosVDSolverStageAccessorFlags E |
Trace/ChaosVDTraceProvider.h | ||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h | |||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h | |||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h | |||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h | |||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h | |||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h | |||
| ChaosVDGeometryBuilder.h | |||
| ChaosVDGeometryDataComponent.h | |||
| ChaosVDPlaybackController.h | |||
| ChaosVDScene.h | |||
| ChaosVDSceneParticle.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneParticleFlags.h | |||
| ChaosVDSceneStreaming.h | |||
| Trace/ChaosVDTraceProvider.h |