Navigation
API > API/Plugins > API/Plugins/ChaosVD
Provider class for Chaos VD trace recordings. It stores and handles rebuilt recorded frame data from Trace events dispatched by the Chaos VD Trace analyzer
| Name | FChaosVDTraceProvider |
| Type | class |
| Header File | /Engine/Plugins/ChaosVD/Source/ChaosVD/Public/Trace/ChaosVDTraceProvider.h |
| Include Path | #include "Trace/ChaosVDTraceProvider.h" |
Syntax
class FChaosVDTraceProvider :
public TraceServices::IProvider,
public TraceServices::IEditableProvider,
public TSharedFromThis< FChaosVDTraceProvider >
Inheritance Hierarchy
- TraceServices::IProvider → FChaosVDTraceProvider
- TraceServices::IEditableProvider → FChaosVDTraceProvider
- FSharedFromThisBase → TSharedFromThis → FChaosVDTraceProvider
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FChaosVDTraceProvider
(
TraceServices::IAnalysisSession& InSession |
Trace/ChaosVDTraceProvider.h |
Structs
| Name | Remarks |
|---|---|
| FBinaryDataContainer |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| ProviderName | FName | Trace/ChaosVDTraceProvider.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bDefaultDataProcessorsRegistered | bool | Trace/ChaosVDTraceProvider.h | ||
| bHasRecordingOverride | bool | Trace/ChaosVDTraceProvider.h | ||
| bShouldTrimOutStartEmptyFrames | bool | Trace/ChaosVDTraceProvider.h | ||
| CurrentGameFrame | TWeakPtr< FChaosVDGameFrameData > | Trace/ChaosVDTraceProvider.h | ||
| CurrentGameFrameQueue | TQueue< TSharedPtr< FChaosVDGameFrameData > > | Trace/ChaosVDTraceProvider.h | ||
| CurrentGameFrameQueueSize | int32 | Trace/ChaosVDTraceProvider.h | ||
| CurrentHeaderData | TUniquePtr< Chaos::VisualDebugger::FChaosVDArchiveHeader > | Trace/ChaosVDTraceProvider.h | ||
| CurrentNetworkTickOffsets | TMap< int32, int32 > | Trace/ChaosVDTraceProvider.h | ||
| CurrentSolverFramesByID | TMap< int32, FChaosVDSolverFrameData > | Trace/ChaosVDTraceProvider.h | ||
| DataProcessedSoFarCounter | int64 | Trace/ChaosVDTraceProvider.h | ||
| HeaderData | Chaos::VisualDebugger::FChaosVDArchiveHeader | Trace/ChaosVDTraceProvider.h | ||
| InternalRecording | TSharedPtr< FChaosVDRecording > | Trace/ChaosVDTraceProvider.h | ||
| MaxGameFramesToQueueNum | int32 | Trace/ChaosVDTraceProvider.h | ||
| MissingDataProcessors | TSet< FString > | Trace/ChaosVDTraceProvider.h | ||
| NameTable | TSharedPtr< Chaos::VisualDebugger::FChaosVDSerializableNameTable > | Trace/ChaosVDTraceProvider.h | ||
| RegisteredDataProcessors | TMap< FStringView, TSharedPtr< FChaosVDDataProcessorBase > > | Trace/ChaosVDTraceProvider.h | ||
| RemappedGameThreadTrackID | int32 | Trace/ChaosVDTraceProvider.h | ||
| RemappedSolversIDs | TSortedMap< int32, int32 > | Trace/ChaosVDTraceProvider.h | ||
| SerializedParticleMetadata | TMap< uint64, TSharedPtr< FChaosVDParticleMetadata > > | Trace/ChaosVDTraceProvider.h | ||
| Session | TraceServices::IAnalysisSession & | Trace/ChaosVDTraceProvider.h | ||
| StartLastCommitedFrameTimeSeconds | double | Trace/ChaosVDTraceProvider.h | ||
| TypesFailedToSerialize | TSet< FString > | Trace/ChaosVDTraceProvider.h | ||
| UnprocessedDataByID | TMap< int32, TSharedPtr< FBinaryDataContainer > > | Trace/ChaosVDTraceProvider.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddParticleMetadata
(
uint64 MetadaId, |
Trace/ChaosVDTraceProvider.h | ||
virtual void BeginEdit() |
Trace/ChaosVDTraceProvider.h | ||
void CreateRecordingInstanceForSession
(
const FString& InSessionName |
Creates a CVD recording instances where all the data loaded from the Trace Analisis session will be stored | Trace/ChaosVDTraceProvider.h | |
bool DoesOwnRecordingInstance() |
Trace/ChaosVDTraceProvider.h | ||
virtual void EditAccessCheck() |
Trace/ChaosVDTraceProvider.h | ||
virtual void EndEdit() |
Trace/ChaosVDTraceProvider.h | ||
| Trace/ChaosVDTraceProvider.h | |||
TWeakPtr< FChaosVDGameFrameData > GetCurrentGameFrame() |
Returns the game thread frame instance that is open and accepting data | Trace/ChaosVDTraceProvider.h | |
FChaosVDSolverFrameData * GetCurrentSolverFrame
(
const int32 InSolverGUID |
Returns the current solver frame instance that is open and accepting data | Trace/ChaosVDTraceProvider.h | |
FChaosVDFrameStageData * GetCurrentSolverStageDataForCurrentFrame
(
int32 SolverID, |
Returns the current open solver stage data for the provided solver ID | Trace/ChaosVDTraceProvider.h | |
int64 GetDataProcessedSoFarNum() |
Returns how many pieces of data we processed so far with a data processor (even if it failed) | Trace/ChaosVDTraceProvider.h | |
const Chaos::VisualDebugger::FChaosVDArchiveHeader & GetHeaderData() |
Returns the FArchive header used to read the serialized binary data | Trace/ChaosVDTraceProvider.h | |
TSharedPtr< Chaos::VisualDebugger::FChaosVDSerializableNameTable > GetNameTableInstance() |
Returns the name table instances used to de-duplicate strings serialization | Trace/ChaosVDTraceProvider.h | |
TSharedPtr< FChaosVDParticleMetadata > GetParticleMetadata
(
uint64 MetadataId |
Trace/ChaosVDTraceProvider.h | ||
TSharedPtr< FChaosVDRecording > GetRecordingForSession() |
Returns the active CVD recording instance | Trace/ChaosVDTraceProvider.h | |
int32 GetRemappedSolverID
(
int32 SolverID |
Trace/ChaosVDTraceProvider.h | ||
const TSet< FString > & GetTypesFailedToSerialize() |
Trace/ChaosVDTraceProvider.h | ||
void RegisterDataProcessor
(
TSharedPtr< FChaosVDDataProcessorBase > InDataProcessor |
Registers a CVD data processors. | Trace/ChaosVDTraceProvider.h | |
int32 RemapSolverID
(
int32 SolverID |
Trace/ChaosVDTraceProvider.h | ||
void SetExternalRecordingInstanceForSession
(
const TSharedRef< FChaosVDRecording >& InExternalCVDRecording |
Trace/ChaosVDTraceProvider.h | ||
void SetHeaderData
(
Chaos::VisualDebugger::FChaosVDArchiveHeader& InNewHeader |
Sets the FArchive header used to read the serialized binary data | Trace/ChaosVDTraceProvider.h | |
void StartGameFrame
(
const TSharedPtr< FChaosVDGameFrameData >& InFrameData |
Opens a game thread frame entry into the active CVD recording structure | Trace/ChaosVDTraceProvider.h | |
void StartSolverFrame
(
const int32 InSolverGUID, |
Opens a solver frame entry into the active CVD recording structure | Trace/ChaosVDTraceProvider.h |