1. Epic GamesDeveloper
  3. FChaosVDRecording

FChaosVDRecording

Struct that represents a recorded Physics simulation.

API > API/Runtime > API/Runtime/ChaosVDData

References

   
Module ChaosVDData
Header /Engine/Source/Runtime/Experimental/ChaosVDData/Public/ChaosVDRecording.h
Include #include "ChaosVDRecording.h"

Syntax

struct FChaosVDRecording

Remarks

Struct that represents a recorded Physics simulation. It is currently populated while analyzing a Trace session

Variables

  Type Name Description
Protected variable bool bIsLive True if this recording is being populated from a live session
Protected variable TArray< FChaosVDGameFrameData > GameFrames  
Protected variable TMap< int32, TMap< int32, FChaosVDSolverFrameData > > GeneratedKeyFrameDataPerSolver  
Protected variable FChaosVDGeometryDataLoaded GeometryDataLoaded  
Protected variable Chaos::VisualDebugger::FChaosVDArchiveHeader HeaderData  
Protected variable TMap< uint32, Chaos::FConstImplicitObjectPtr > ImplicitObjects Id to Ptr map of all shared geometry data required to visualize
Protected variable std::atomic< uint64 > LastUpdatedTimeAsCycle Last Platform Cycle on which this recording was updated
Protected variable TSharedPtr< Chaos::VisualDebugger::FChaosVDSerializableNameTable > NameTable  
Protected variable TMap< int32, TSharedPtr< FChaosVDParticleDataWrapper > > ParticlesOnCurrentGeneratedKeyframe Map that temporary holds generated particle data during the key frame generation process, keeping its memory allocation between generated frames
Protected variable TMap< int32, TArray< FChaosVDSolverFrameData > > RecordedFramesDataPerSolver  
Protected variable TMap< int32, TArray< int32 > > RecordedKeyFramesNumberPerSolver  
Protected variable FRWLock RecordingDataLock  
Public variable FString SessionName Session name of the trace session used to re-build this recording

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddFrameForSolver ( const int32 SolverID,
FChaosVDSolverFrameData&& InFrameData
)

 Adds a Solver Frame Data entry for a specific Solver ID.
Public function void

AddGameFrameData ( const FChaosVDGameFrameData& InFrameData
)

 Adds a Game Frame Data entry. Creates a solver entry if it does not exist
Public function void

AddImplicitObject ( const uint32 ID,
const Chaos::FImplicitObjectPtr& InImplicitObject
)

 Adds a shared Implicit Object to the recording
Public function void

AddImplicitObject ( const uint32 ID,
const TSharedPtr< Chaos::FImplicitObject >& InImplicitObject
)

  
Protected function void

AddImplicitObject ( const uint32 ID,
const Chaos::FImplicitObject* InImplicitObject
)

 Adds an Implicit Object to the recording and takes ownership of it
Protected function void

AddImplicitObject_Internal ( const uint32 ID,
const Chaos::FConstImplicitObjectPtr& InImplicitObject
)

  
Protected function void

AddKeyFrameNumberForSolver ( int32 SolverID,
int32 FrameNumber
)

 Stores a frame number of a solver that is a Key Frame - These are used when scrubbing to make sure the visualization is in sync with what was recorded
Protected function void  
Public function void

CollapseSolverFramesRange_AssumesLocked ( int32 SolverID,
int32 StartFrame,
int32 EndFrame,
FChaosVDSolverFrameData& OutCollapsedFrameData
)

 Collapses the most important frame data from a range of solver frames into a single solver frame data
Public function int32  
Protected function void

GenerateAndStoreKeyframeForSolver_AssumesLocked ( int32 SolverID,
int32 CurrentFrameNumber,
int32 LastKeyFrameNumber
)

  
Public function Const const TArray< FChaosVDGameFrameData > & Returns a reference to the array holding all the available game frames
Public function Const int32 Returns the current available Game Frames
Public function Const int32  
Public function Const int32 Returns the number of available frame data for the specified solver ID
Public function Const int32  
Public function void

GetAvailableSolverIDsAtGameFrame ( const FChaosVDGameFrameData& GameFrameData,
TArray< int32 >& OutSolversID
)

  
Public function void  
Public function void

GetAvailableSolverIDsAtGameFrameNumber ( int32 FrameNumber,
TArray< int32 >& OutSolversID
)

 Gathers all available solvers IDs at the given Game frame number
Public function void  
Public function Const const TMap< int32, TArray< FChaosVDSolverFrameData > > & Returns a reference to the map containing the available solver data
Public function Const int32 Returns the current available recorded solvers number
Public function FChaosVDGameFrameData * Searches for a recorded Game frame at the specified cycle
Public function FChaosVDGameFrameData * Searches for a recorded Game frame at the specified cycle
Public function Const const TMap< uint32, TSharedPtr< const Chaos::FImplicitObject > > &  
Public function Const const TMap< uint32, Chaos::FConstImplicitObjectPtr > & Returns a reference to the GeometryID-ImplicitObject map of this recording
Public function Const const Chaos::VisualDebugger::FChaosVDArchiveHeader & Returns the FArchive header used to read the serialized binary data
Public function FChaosVDGameFrameData * Returns a ptr to the last recorded game frame - This is a ptr to the array element. Do not store
Public function uint64 Returns the last Platform Cycle on which this recording was updated (A new frame was added)
Public function int32 Searches and returns the lowest game frame number at the specified solver frame
Public function int32 Searches and returns the lowest game frame number at the specified cycle
Public function int32 Searches and returns the lowest frame number of a solver at the specified cycle
Public function int32  
Public function int32 Searches and returns the lowest frame number of a solver at the specified cycle
Public function Const TSharedPtr< Chaos::VisualDebugger::FChaosVDSerializableNameTable > Returns the name table instances used to de-duplicate strings serialization
Public function FRWLock &  
Public function FChaosVDSolverFrameData *

GetSolverFrameData_AssumesLocked ( int32 SolverID,
int32 FrameNumber,
bool bKeyFrameOnly
)

 Return a ptr to the existing solver frame data from the specified ID and Frame number
Public function FChaosVDSolverFrameData * Return a ptr to the existing solver frame data from the specified ID and Frame number
Public function FString

GetSolverName ( int32 SolverID
)

 Returns the name of the specified solver id
Public function FString Returns the name of the specified solver id. Must be called from within a ReadLock
Public function Const bool

IsEmpty ()

 Returns true if this recording does not have any usable data
Public function Const bool

IsLive ()

 Returns true if this recording is being populated from a live session
Public function FChaosVDGeometryDataLoaded & Called each time new geometry data becomes available in the recording - Mainly when a new frame is added from the Trace analysis
Public function void Sets the FArchive header used to read the serialized binary data
Public function void

SetIsLive ( bool bNewIsLive
)

 Sets if this recording is being populated from a live session

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page