1. Epic GamesDeveloper
  3. FRewindData

FRewindData

Unreal Engine C++ API Reference > Runtime > Chaos

References

   
Module Chaos
Header /Engine/Source/Runtime/Experimental/Chaos/Public/RewindData.h
Include #include "RewindData.h"

Syntax

class FRewindData

Constructors

  Type Name Description
Public function  

FRewindData ( FPBDRigidsSolver* InSolver,
int32 NumFrames,
int32 InCurrentFrame
)

  
Public function  

FRewindData ( FPBDRigidsSolver* InSolver,
int32 NumFrames,
bool InRewindDataOptimization,
int32 InCurrentFrame
)

  

Functions

  Type Name Description
Public function void  
Public function void

AddInputHistory ( const TSharedPtr< FBaseRewindHistory >& InputHistory
)

 Add input history to the rewind data for future use while resimulating
Public function void

AddInputsHistory ( const TSharedPtr< FBaseRewindHistory >& InputsHistory
)

  
Public function void

AddStateHistory ( const TSharedPtr< FBaseRewindHistory >& StateHistory
)

 Add state history to the rewind data for future use while rewinding
Public function void

AddStatesHistory ( const TSharedPtr< FBaseRewindHistory >& StatesHistory
)

  
Public function void

AdvanceFrame ( FReal DeltaTime,
const CreateCache& CreateCacheFunc
)

  
Public function void

ApplyInputs ( const int32 ApplyFrame,
const bool bResetSolver
)

 Apply inputs for specified frame from rewind data
Public function void This blocks any future resimulation to rewind back past the frame this is called on
Public function void  
Public function Const int32  
Public function Static bool

CheckQuaternionThreshold ( FQuat A,
FQuat B,
float ThresholdDegrees
)

  
Public function Static bool

CheckVectorThreshold ( FVec3 A,
FVec3 B,
float Threshold
)

  
Public function void Clear all the simulation history after Frame
Public function const int32 Check if we have received targets already for the last frame simulated, if so compare those with the result of the simulation and if they desync return the frame value to request a rewind for to correct the desync NOTE: This only happens when the client has desynced and is behind the server, so we receive server states for frames not yet simulated
Public function Const int32  
Public function void

DumpHistory_Internal ( const int32 FramePrintOffset,
const FString& Filename
)

  
Public function void

ExtendHistoryWithFrame ( const int32 Frame
)

 Extend the current history size to be sure to include the given frame
Public function void

ExtractHistoryState ( FGeometryParticleHandle& Handle,
int32& PositionValidCount,
int32& VelocityValidCount,
int32& PositionNextIterator,
int32& VelocityNextIterator
)

 Extract some history information before cleaning/pushing state
Public function int32

FindValidResimFrame ( const int32 RequestedFrame
)

 Find the first previous valid frame having received physics target from the server
Public function void  
Public function int32 Get the latest frame resim has been blocked from rewinding past
Public function Const IResimCacheBase *  
Public function Const FReal  
Public function Const int32  
Public function Const int32  
Public function Const int32  
Public function Const int32 Number of particles that we're currently storing history for.
Public function Const FJointState Query the state of joints from the past. Can only be used when not already resimming
Public function Const FGeometryParticleState Query the state of particles from the past. Can only be used when not already resimming
Public function int32 Get and set the frame we resimulate from
Public function Const const FPBDRigidsSolver * Return the rewind data solver
Public function Const bool Check if a resim cache based on IResimCacheBase (FEvolutionResimCache by default) is being used.
Public function void

Init ( FPBDRigidsSolver* InSolver,
int32 NumFrames,
bool InRewindDataOptimization,
int32 InCurrentFrame
)

  
Public function void

Init ( FPBDRigidsSolver* InSolver,
int32 NumFrames,
int32 InCurrentFrame
)

  
Public function Const bool  
Public function Const bool

IsResim ()

  
Public function void  
Public function void  
Public function void

PushGTDirtyData ( const FDirtyPropertiesManager& SrcManager,
const int32 SrcDataIdx,
const FDirtyProxy& Dirty,
const FShapeDirtyData* ShapeDirtyData
)

  
Public function void

PushPTDirtyData ( TPBDRigidParticleHandle< FReal, 3 >& Rigid,
const int32 SrcDataIdx
)

  
Public function void

PushStateAtFrame ( FGeometryParticleHandle& Handle,
int32 Frame,
FFrameAndPhase::EParticleHistoryPhase Phase,
const FVector& Position,
const FQuat& Quaternion,
const FVector& LinVelocity,
const FVector& AngVelocity,
const bool bShouldSleep
)

 Push a physics state in the rewind data at specified frame
Public function void

RemoveInputHistory ( const TSharedPtr< FBaseRewindHistory >& InputHistory
)

 Remove input history from the rewind data
Public function void

RemoveInputsHistory ( const TSharedPtr< FBaseRewindHistory >& InputsHistory
)

  
Public function void

RemoveObject ( const FGeometryParticleHandle* Particle,
const bool bAllowShrinking
)

  
Public function void

RemoveObject ( const FGeometryParticleHandle* Particle,
const EAllowShrinking AllowShrinking
)

  
Public function void

RemoveObject ( const FPBDJointConstraintHandle* Joint,
const EAllowShrinking AllowShrinking
)

  
Public function void

RemoveObject ( const FPBDJointConstraintHandle* Joint,
const bool bAllowShrinking
)

  
Public function void

RemoveStateHistory ( const TSharedPtr< FBaseRewindHistory >& StateHistory
)

 Remove state history from the rewind data
Public function void

RemoveStatesHistory ( const TSharedPtr< FBaseRewindHistory >& StatesHistory
)

  
Public function void

RestoreHistoryState ( FGeometryParticleHandle& Handle,
const int32& PositionValidCount,
const int32& VelocityValidCount,
const int32& PositionNextIterator,
const int32& VelocityNextIterator
)

 Restore some history information after cleaning/pushing state
Public function void

RewindStates ( const int32 RewindFrame,
const bool bResetSolver
)

 Rewind to state for a specified frame from rewind data
Public function void

SetResimFrame ( int32 Frame
)

  
Public function void

SetRewindDataOptimization ( bool InRewindDataOptimization
)

 Set if RewindData optimizations should be enabled or not.
Public function void

SetTargetStateAtFrame ( FGeometryParticleHandle& Handle,
const int32 Frame,
FFrameAndPhase::EParticleHistoryPhase Phase,
const FVector& Position,
const FQuat& Quaternion,
const FVector& LinVelocity,
const FVector& AngVelocity,
const bool bShouldSleep
)

  
Public function void  

Typedefs

Name Description
FDirtyJointInfo  
FDirtyParticleInfo  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page