UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FChaosVDSolverFrameData Struct Reference

#include <ChaosVDRecording.h>

Public Member Functions

PRAGMA_DISABLE_DEPRECATION_WARNINGS FChaosVDSolverFrameData ()=default
 
 FChaosVDSolverFrameData (const FChaosVDSolverFrameData &Other)=default
 
 FChaosVDSolverFrameData (FChaosVDSolverFrameData &&Other) noexcept=default
 
FChaosVDSolverFrameDataoperator= (const FChaosVDSolverFrameData &Other)=default
 
FChaosVDSolverFrameDataoperator= (FChaosVDSolverFrameData &&Other) noexcept=default
 
double GetFrameTime () const
 
bool HasNetworkSyncData (EChaosVDNetworkSyncDataRequirements Requirements=EChaosVDNetworkSyncDataRequirements::All) const
 
int32 GetClampedNetworkTickOffset () const
 
FChaosVDCustomFrameDataGetCustomData ()
 
const FChaosVDCustomFrameDataGetCustomData () const
 
EChaosVDSolverFrameAttributes GetAttributes () const
 
void AddAttributes (EChaosVDSolverFrameAttributes NewAttributes)
 
void RemoveAttributes (EChaosVDSolverFrameAttributes AttributesToRemove)
 

Public Attributes

PRAGMA_ENABLE_DEPRECATION_WARNINGS FName DebugFName
 
FString DebugName
 
int32 SolverID = INDEX_NONE
 
int32 InternalFrameNumber = INDEX_NONE
 
int32 NetworkTickOffset = INDEX_NONE
 
uint64 FrameCycle = 0
 
Chaos::FRigidTransform3 SimulationTransform
 
bool bIsKeyFrame = false
 
bool bIsResimulated = false
 
FChaosVDFrameStagesContainer SolverSteps
 
TSet< int32ParticlesDestroyedIDs
 
double StartTime = -1.0
 
double EndTime = -1.0
 
TArray< TSharedPtr< FChaosVDCharacterGroundConstraint > > RecordedCharacterGroundConstraints
 

Constructor & Destructor Documentation

◆ FChaosVDSolverFrameData() [1/3]

PRAGMA_DISABLE_DEPRECATION_WARNINGS FChaosVDSolverFrameData::FChaosVDSolverFrameData ( )
default

◆ FChaosVDSolverFrameData() [2/3]

FChaosVDSolverFrameData::FChaosVDSolverFrameData ( const FChaosVDSolverFrameData Other)
default

◆ FChaosVDSolverFrameData() [3/3]

FChaosVDSolverFrameData::FChaosVDSolverFrameData ( FChaosVDSolverFrameData &&  Other)
defaultnoexcept

Member Function Documentation

◆ AddAttributes()

void FChaosVDSolverFrameData::AddAttributes ( EChaosVDSolverFrameAttributes  NewAttributes)
inline

◆ GetAttributes()

EChaosVDSolverFrameAttributes FChaosVDSolverFrameData::GetAttributes ( ) const
inline

◆ GetClampedNetworkTickOffset()

int32 FChaosVDSolverFrameData::GetClampedNetworkTickOffset ( ) const
inline

Returns the current network tick offset. If we didn't have recorded a network tick, we will still return 0 to keep compatibility with other files

◆ GetCustomData() [1/2]

FChaosVDCustomFrameData & FChaosVDSolverFrameData::GetCustomData ( )
inline

◆ GetCustomData() [2/2]

const FChaosVDCustomFrameData & FChaosVDSolverFrameData::GetCustomData ( ) const
inline

◆ GetFrameTime()

double FChaosVDSolverFrameData::GetFrameTime ( ) const
inline

Calculates and returns the frame time for this recorded frame.

Returns
Calculated frame time. -1 if it was not recorded

◆ HasNetworkSyncData()

bool FChaosVDSolverFrameData::HasNetworkSyncData ( EChaosVDNetworkSyncDataRequirements  Requirements = EChaosVDNetworkSyncDataRequirements::All) const
inline

Returns true if we have the necessary data to sync this frame with other frame based on network ticks offsets

◆ operator=() [1/2]

FChaosVDSolverFrameData & FChaosVDSolverFrameData::operator= ( const FChaosVDSolverFrameData Other)
default

◆ operator=() [2/2]

FChaosVDSolverFrameData & FChaosVDSolverFrameData::operator= ( FChaosVDSolverFrameData &&  Other)
defaultnoexcept

◆ RemoveAttributes()

void FChaosVDSolverFrameData::RemoveAttributes ( EChaosVDSolverFrameAttributes  AttributesToRemove)
inline

Member Data Documentation

◆ bIsKeyFrame

bool FChaosVDSolverFrameData::bIsKeyFrame = false

◆ bIsResimulated

bool FChaosVDSolverFrameData::bIsResimulated = false

◆ DebugFName

PRAGMA_ENABLE_DEPRECATION_WARNINGS FName FChaosVDSolverFrameData::DebugFName

◆ DebugName

FString FChaosVDSolverFrameData::DebugName

◆ EndTime

double FChaosVDSolverFrameData::EndTime = -1.0

◆ FrameCycle

uint64 FChaosVDSolverFrameData::FrameCycle = 0

◆ InternalFrameNumber

int32 FChaosVDSolverFrameData::InternalFrameNumber = INDEX_NONE

◆ NetworkTickOffset

int32 FChaosVDSolverFrameData::NetworkTickOffset = INDEX_NONE

◆ ParticlesDestroyedIDs

TSet<int32> FChaosVDSolverFrameData::ParticlesDestroyedIDs

◆ RecordedCharacterGroundConstraints

TArray<TSharedPtr<FChaosVDCharacterGroundConstraint> > FChaosVDSolverFrameData::RecordedCharacterGroundConstraints

◆ SimulationTransform

Chaos::FRigidTransform3 FChaosVDSolverFrameData::SimulationTransform

◆ SolverID

int32 FChaosVDSolverFrameData::SolverID = INDEX_NONE

◆ SolverSteps

FChaosVDFrameStagesContainer FChaosVDSolverFrameData::SolverSteps

◆ StartTime

double FChaosVDSolverFrameData::StartTime = -1.0

The documentation for this struct was generated from the following file: