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 TArray< FChaosVDGameFrameData > GameFrames  
Protected variable FChaosVDGeometryDataLoaded GeometryDataLoaded  
Protected variable TMap< uint32, TSharedPtr< const Chaos::FImplicitObject > > ImplicitObjects Id to Ptr map of all shared geometry data required to visualize
Protected variable TMap< int32, TArray< FChaosVDSolverFrameData > > RecordedFramesDataPerSolver  
Protected variable TMap< int32, TArray< int32 > > RecordedKeyFramesNumberPerSolver  
Protected variable FChaosVDRecordingUpdated RecordingUpdatedDelegate  
Public variable FString SessionName Session name of the trace session used to re-build this recording

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 Adds a Game Frame Data entry. Creates a solver entry if it does not exist
Public function void

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

 Adds a shared Implicit Object to the recording
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 TSharedPtr< const Chaos::FImplicitObject >& 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
Public function int32

FindFirstSolverKeyFrameNumberFromFrame ( int32 SolverID,
int32 StartFrameNumber
)

  
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

GetAvailableSolverFramesNumber ( int32 SolverID
)

 Returns the number of available frame data for the specified solver ID
Public function void

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

 Gathers all available solvers IDs at the given Game frame number
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 *

GetGameFrameData ( int32 FrameNumber
)

 Searches for a recorded Game frame at the specified cycle
Public function FChaosVDGameFrameData *

GetGameFrameDataAtCycle ( uint64 Cycle
)

 Searches for a recorded Game frame at the specified cycle
Public function Const const TMap< uint32, TSharedPtr< const Chaos::FImplicitObject > > & Returns a reference to the GeometryID-ImplicitObject map of this recording
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 int32

GetLowestGameFrameAtSolverFrameNumber ( int32 SolverID,
int32 SolverFrame
)

 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

GetLowestSolverFrameNumberAtCycle ( int32 SolverID,
uint64 Cycle
)

 Searches and returns the lowest frame number of a solver at the specified cycle
Public function int32

GetLowestSolverFrameNumberGameFrame ( int32 SolverID,
int32 GameFrame
)

 Searches and returns the lowest frame number of a solver at the specified cycle
Public function FChaosVDSolverFrameData *

GetSolverFrameData ( int32 SolverID,
int32 FrameNumber
)

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

GetSolverFrameDataAtCycle ( int32 SolverID,
uint64 Cycle
)

 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 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 FChaosVDRecordingUpdated & Called each time the recording changes - Mainly when a new frame is added from the Trace analysis

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page