1. Epic GamesDeveloper
  3. FChaosVDRecording

FChaosVDRecording

Struct that represents a recorded Physics simulation.

API > API/Runtime > API/Runtime/ChaosVDData

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

   
Name FChaosVDRecording
Type struct
Header File /Engine/Source/Runtime/Experimental/ChaosVDData/Public/ChaosVDRecording.h
Include Path #include "ChaosVDRecording.h"

Syntax

struct FChaosVDRecording

Constructors

Name Remarks Include Path Unreal Specifiers

FChaosVDRecording()

   ChaosVDRecording.h  

Constants

Name Type Remarks Include Path
CommonTrackCount int32 Constant used to define inline allocators - Unless there are some scenarios with a lot of RBAN solvers in the recording, we usually don't go over 3 tracks most of the time so 16 should be plenty by default ChaosVDRecording.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
SessionName FString Session name of the trace session used to re-build this recording ChaosVDRecording.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
CustomData FChaosVDCustomFrameData   ChaosVDRecording.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddAttributes ( EChaosVDRecordingAttributes Attributes
)

   ChaosVDRecording.h  

void AddFrameForSolver ( const int32 SolverID,
FChaosVDSolverFrameData&& InFrameData
)

 Adds a Solver Frame Data entry for a specific Solver ID. ChaosVDRecording.h  

void AddGameFrameData ( const FChaosVDGameFrameData& InFrameData
)

 Adds a Game Frame Data entry. Creates a solver entry if it does not exist ChaosVDRecording.h  

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

 Adds a shared Implicit Object to the recording ChaosVDRecording.h  

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

   ChaosVDRecording.h  

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 ChaosVDRecording.h  

void CommitSolverID ( int32 SolverID
)

   ChaosVDRecording.h  

void CommitSolverID_AssumesLocked ( int32 SolverID
)

   ChaosVDRecording.h  

int32 FindFirstSolverKeyFrameNumberFromFrame_AssumesLocked ( int32 SolverID,
int32 StartFrameNumber
)

   ChaosVDRecording.h  

EChaosVDRecordingAttributes GetAttributes()

   ChaosVDRecording.h  

EChaosVDRecordingAttributes GetAttributes_AssumesLocked()

   ChaosVDRecording.h  

const TArray< FChaosVDGameFrameData > & GetAvailableGameFrames_AssumesLocked()

 Returns a reference to the array holding all the available game frames ChaosVDRecording.h  

int32 GetAvailableGameFramesNumber()

 Returns the current available Game Frames ChaosVDRecording.h  

int32 GetAvailableGameFramesNumber_AssumesLocked()

   ChaosVDRecording.h  

int32 GetAvailableSolverFramesNumber ( int32 SolverID
) const

 Returns the number of available frame data for the specified solver ID ChaosVDRecording.h  

int32 GetAvailableSolverFramesNumber_AssumesLocked ( int32 SolverID
) const

   ChaosVDRecording.h  

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

   ChaosVDRecording.h  

void GetAvailableSolverIDsAtGameFrame_AssumesLocked ( const FChaosVDGameFrameData& GameFrameData,
TArray< int32, TAllocator >& OutSolversID
)

   ChaosVDRecording.h  

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

 Gathers all available solvers IDs at the given Game frame number ChaosVDRecording.h  

void GetAvailableSolverIDsAtGameFrameNumber_AssumesLocked ( int32 FrameNumber,
TArray< int32, TAllocator >& OutSolversID
)

   ChaosVDRecording.h  

const TMap< int32, TArray< FChaosVDSolverFrameData > > & GetAvailableSolvers_AssumesLocked()

 Returns a reference to the map containing the available solver data ChaosVDRecording.h  

int32 GetAvailableSolversNumber_AssumesLocked()

 Returns the current available recorded solvers number ChaosVDRecording.h  

int32 GetAvailableTrackIDForRemapping()

   ChaosVDRecording.h  

TSharedPtr< FChaosVDCollisionChannelsInfoContainer > GetCollisionChannelsInfoContainer()

   ChaosVDRecording.h  
  ChaosVDRecording.h  
  ChaosVDRecording.h  

FChaosVDGameFrameData * GetGameFrameData_AssumesLocked ( int32 FrameNumber
)

 Searches for a recorded Game frame at the specified cycle ChaosVDRecording.h  

FChaosVDGameFrameData * GetGameFrameDataAtCycle_AssumesLocked ( uint64 Cycle
)

 Searches for a recorded Game frame at the specified cycle ChaosVDRecording.h  

const TMap< uint32, TSharedPtr< const Chaos::FImplicitObject > > & GetGeometryDataMap()

   ChaosVDRecording.h  

const TMap< uint32, Chaos::FConstImplicitObjectPtr > & GetGeometryMap()

 Returns a reference to the GeometryID-ImplicitObject map of this recording ChaosVDRecording.h  

FChaosVDGameFrameData * GetLastGameFrameData_AssumesLocked()

 Returns a ptr to the last recorded game frame - This is a ptr to the array element. Do not store ChaosVDRecording.h  

uint64 GetLastUpdatedTimeAsCycle()

 Returns the last Platform Cycle on which this recording was updated (A new frame was added) ChaosVDRecording.h  

int32 GetLowestGameFrameAtSolverFrameNumber ( int32 SolverID,
int32 SolverFrame
)

 Searches and returns the lowest game frame number at the specified solver frame ChaosVDRecording.h  

int32 GetLowestGameFrameAtSolverFrameNumber_AssumesLocked ( int32 SolverID,
int32 SolverFrame
)

   ChaosVDRecording.h  

int32 GetLowestGameFrameNumberAtCycle ( uint64 Cycle
)

 Searches and returns the lowest game frame number at the specified cycle ChaosVDRecording.h  

int32 GetLowestGameFrameNumberAtCycle_AssumesLocked ( uint64 Cycle
)

   ChaosVDRecording.h  

int32 GetLowestGameFrameNumberAtTime ( double Time
)

 Searches and returns the lowest game frame number at the specified cycle ChaosVDRecording.h  

int32 GetLowestSolverFrameNumberAtCycle ( int32 SolverID,
uint64 Cycle
)

 Searches and returns the lowest frame number of a solver at the specified cycle ChaosVDRecording.h  

int32 GetLowestSolverFrameNumberAtCycle_AssumesLocked ( int32 SolverID,
uint64 Cycle
)

   ChaosVDRecording.h  

int32 GetLowestSolverFrameNumberAtNetworkFrameNumber_AssumesLocked ( int32 SolverID,
int32 NetworkFrameNumber
)

   ChaosVDRecording.h  

int32 GetLowestSolverFrameNumberGameFrame ( int32 SolverID,
int32 GameFrame
)

 Searches and returns the lowest frame number of a solver at the specified cycle ChaosVDRecording.h  

int32 GetLowestSolverFrameNumberGameFrame_AssumesLocked ( int32 SolverID,
int32 GameFrame
)

   ChaosVDRecording.h  

FRWLock & GetRecordingDataLock()

   ChaosVDRecording.h  

FName GetSolverFName ( int32 SolverID
)

 Returns the name of the specified solver id ChaosVDRecording.h  

FName GetSolverFName_AssumedLocked ( int32 SolverID
)

 Returns the name of the specified solver id. Must be called from within a ReadLock ChaosVDRecording.h  

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 ChaosVDRecording.h  

FChaosVDSolverFrameData * GetSolverFrameDataAtCycle_AssumesLocked ( int32 SolverID,
uint64 Cycle
)

 Return a ptr to the existing solver frame data from the specified ID and Frame number ChaosVDRecording.h  

FString GetSolverName ( int32 SolverID
)

   ChaosVDRecording.h  

FString GetSolverName_AssumedLocked ( int32 SolverID
)

   ChaosVDRecording.h  

bool HasSolverID ( int32 SolverID
)

   ChaosVDRecording.h  

bool HasSolverID_AssumesLocked ( int32 SolverID
)

   ChaosVDRecording.h  

bool IsEmpty()

 Returns true if this recording does not have any usable data ChaosVDRecording.h  

bool IsLive()

 Returns true if this recording is being populated from a live session ChaosVDRecording.h  

bool IsServerSolver ( int32 SolverID
)

   ChaosVDRecording.h  

bool IsServerSolver_AssumesLocked ( int32 SolverID
)

   ChaosVDRecording.h  

FChaosVDGeometryDataLoaded & OnGeometryDataLoaded()

 Called each time new geometry data becomes available in the recording - Mainly when a new frame is added from the Trace analysis ChaosVDRecording.h  

void RemoveAttributes ( EChaosVDRecordingAttributes Attributes
)

   ChaosVDRecording.h  

void ReserveSolverID ( int32 SolverID
)

   ChaosVDRecording.h  

void ReserveSolverID_AssumesLocked ( int32 SolverID
)

   ChaosVDRecording.h  

void SetCollisionChannelsInfoContainer ( const TSharedPtr< FChaosVDCollisionChannelsInfoContainer >& InCollisionChannelsInfo
)

   ChaosVDRecording.h  

void SetIsLive ( bool bNewIsLive
)

 Sets if this recording is being populated from a live session ChaosVDRecording.h  

Protected

Name Remarks Include Path Unreal Specifiers

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

 Adds an Implicit Object to the recording and takes ownership of it ChaosVDRecording.h  

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

   ChaosVDRecording.h  

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 ChaosVDRecording.h  

void AddKeyFrameNumberForSolver_AssumesLocked ( int32 SolverID,
int32 FrameNumber
)

   ChaosVDRecording.h  

void GenerateAndStoreKeyframeForSolver_AssumesLocked ( int32 SolverID,
int32 CurrentFrameNumber,
int32 LastKeyFrameNumber
)

   ChaosVDRecording.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page