1. Epic GamesDeveloper
  3. FPhysicsSolverBase

FPhysicsSolverBase

Unreal Engine C++ API Reference > Runtime > Chaos > Chaos > Framework

Inheritance Hierarchy

References

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

Syntax

class FPhysicsSolverBase : public Chaos::FPhysicsSolverEvents

Variables

  Type Name Description
Protected variable bool bGameThreadFrozen  
Protected variable bool bIsStandaloneSolver Boolean to check if the solver is a standalone solver responsible to spawn its own task
Protected variable bool bSolverHasFrozenGameThreadCallbacks  
Protected variable EMultiBufferMode BufferMode Mode that the results buffers should be set to (single, double, triple)
Protected variable bool bUseCollisionResimCache  
Protected variable TArray< ISimCallbackObject * > CCDModifiers  
Protected variable TArray< ISimCallbackObject * > ContactModifiers  
Protected variable FChaosMarshallingManager MarshallingManager  
Protected variable TArray< ISimCallbackObject * > MidPhaseModifiers  
Protected variable FReal MLastDt  
Protected variable TUniquePtr< IRewindCallback > MRewindCallback  
Protected variable TUniquePtr< FRewindData > MRewindData  
Protected variable FReal MTime  
Protected variable TUniquePtr< FPendingSpatialDataQueue > PendingSpatialOperations_External The spatial operations not yet consumed by the internal sim. Use this to ensure any GT operations are seen immediately.
Protected variable FGraphEventRef PendingTasks  
Protected variable TArray< ISimCallbackObject * > PhysicsObjectUnregistrationWatchers  
Protected variable FPhysicsReplicationAsync * PhysicsReplication  
Protected variable TUniquePtr< FChaosResultsManager > PullResultsManager  
Protected variable TArray< ISimCallbackObject * > RegistrationWatchers  
Protected variable TArray< ISimCallbackObject * > SimCallbackObjects  
Protected variable TArray< ISimCallbackObject * > StrainModifiers  
Protected variable EThreadingModeTemp ThreadingMode  
Protected variable TArray< ISimCallbackObject * > UnregistrationWatchers  

Constructors

  Type Name Description
Protected function    
Protected function    
Protected function    
Protected function  

FPhysicsSolverBase ( const EMultiBufferMode BufferingModeIn,
const EThreadingModeTemp InThreadingMode,
UObject* InOwner,
FReal AsyncDt
)

 Protected construction so callers still have to go through the module to create new instances

Destructors

  Type Name Description
Protected function Virtual   Only allow construction with valid parameters as well as restricting to module construction

Functions

  Type Name Description
Public function void

AddDirtyProxiesUnsafe ( TProxiesArray& ProxiesArray
)

 Batch dirty proxies without checking DirtyIdx.
Public function void

AddDirtyProxy ( IPhysicsProxyBase* ProxyBaseIn
)

  
Public function void

AddDirtyProxyShape ( IPhysicsProxyBase* ProxyBaseIn,
int32 ShapeIdx
)

  
Public function FGraphEventRef  
Protected function void

AdvanceSolverBy ( const FSubStepInfo& SubStepInfo
)

  
Public function Virtual void  
Public function Virtual Const bool  
Public function Static bool Check if we can enable debugging informations for network physics
Public function FPBDRigidsSolver &  
Public function void

CastHelper ( const Lambda& Func
)

  
Public function void  
Protected function void  
Public function Virtual void  
Public function TSimCallbackObjectType *

CreateAndRegisterSimCallbackObject_External ( bool bContactModification,
bool bRegisterRewindCallback
)

  
Public function TSimCallbackObjectType * Creates a new sim callback object of the type given.
Protected function Static void  
Public function void  
Public function void

EnableAsyncMode ( FReal FixedDt
)

  
Public function void

EnqueueCommandImmediate ( Lambda&& Func
)

  
Public function void  
Public function void  
Public function Virtual void  
Public function Const FReal  
Public function Const FReal  
Public function Const float  
Public function Const FName  
Public function const FDirtyProxiesBucketInfo &  
Public function int32  
Public function Const FPhysSceneLock & NOTE: this is a const operation so that you can acquire a read lock on a const solver. The assumption is that non-const write operations are already marked non-const.
Public function Const FReal  
Public function FChaosMarshallingManager &  
Public function Const float  
Public function Const int32  
Public function Const float  
Public function Const const UObject *  
Public function Static int32 Get the number of physics history frames to cache
Public function Static float Get the time length to cache physics history for, based on Project Settings -> Physics -> Physics Prediction -> MaxSupportedLatencyPrediction
Public function FPhysicsReplicationAsync *  
Public function Const FReal Returns the time used by physics results. If fixed dt is used this will be the interpolated time
Public function Static float  
Public function Static bool  
Public function Static float  
Public function Static bool  
Public function Static float  
Public function Static bool  
Public function Static float  
Public function Static bool  
Public function FChaosResultsManager &  
Public function IRewindCallback *  
Public function FRewindData *  
Public function Const bool  
Public function Const const FReal  
Public function Const EThreadingModeTemp  
Public function Const bool Check if an additional resim cache based on IResimCacheBase (FEvolutionResimCache by default) is being used.
Public function Const bool Tells us if we're on the frozen game thread.
Public function Static bool Check if network physics is enables or not
Public function Const bool  
Public function Const bool  
Public function Virtual Const bool  
Public function Const bool  
Public function Const bool Get the standalone solver flag
Public function Const bool  
Public function Const bool  
Public function Virtual void  
Public function void  
Public function Static float Return the interpolation lerp in case the resim is off
Public function void  
Protected function void

PrepareAdvanceBy ( const FReal Dt
)

  
Protected function void  
Public function void

PullPhysicsStateForEachDirtyProxy_External ( TDispatcher& Dispatcher
)

 Used to update external thread data structures.
Public function void

PullPhysicsStateForEachDirtyProxy_External ( const RigidLambda& RigidFunc,
const ConstraintLambda& ConstraintFunc
)

  
Public function void

PullPhysicsStateForEachDirtyProxy_External ( const RigidLambda& RigidFunc,
const ConstraintLambda& ConstraintFunc,
const GeometryCollectionLambda& GeometryCollectionFunc
)

 Pulls physics state for each dirty particle and allows caller to do additional work if needed.
Protected function void

PushPhysicsState ( const FReal Dt,
const int32 NumSteps,
const int32 NumExternalSteps
)

  
Public function void

RegisterSimOneShotCallback ( Lambda&& Func
)

  
Public function void  
Public function void  
Public function Static float  
Public function void

SetAsyncInterpolationMultiplier ( FRealSingle InAsyncInterpolationMultiplier
)

 Set the async interpolation multiplier which is how many multiples of the fixed dt should we look behind for interpolation.
Public function void Set the Async Block Mode, valid mode can be 0, 1, or 2 0 blocks on any physics steps generated from past GT Frames, and blocks on none of the tasks from current frame.
Public function void  
Protected function void  
Public function void

SetGameThreadFrozen ( bool InGameThreadFrozen
)

  
Public function void

SetIsPaused_External ( bool bShouldPause
)

  
Public function void

SetMaxDeltaTime_External ( float InMaxDeltaTime
)

  
Public function void

SetMaxSubSteps_External ( const int32 InMaxSubSteps
)

  
Public function void

SetMinDeltaTime_External ( float InMinDeltaTime
)

  
Public function void

SetNumDirtyShapes ( IPhysicsProxyBase* Proxy,
int32 NumShapes
)

  
Public function void

SetOwner ( const UObject* InOwner
)

  
Public function void

SetPhysicsReplication ( FPhysicsReplicationAsync* InPhysicsReplication
)

  
Public function void

SetRewindCallback ( TUniquePtr< IRewindCallback >&& RewindCallback
)

  
Public function void

SetSolverSubstep_External ( bool bInSubstepExternal
)

  
Public function void

SetSolverTime ( const FReal InTime
)

  
Public function void

SetStandaloneSolver ( const bool bStandaloneSolver
)

 Set the standalone solver flag
Public function void

SetStealAdvanceTasks_ForTesting ( bool bInStealAdvanceTasksForTesting
)

  
Public function void  
Public function void

SetUseCollisionResimCache ( bool InUseCollisionResimCache
)

 Enable or disable an additional resim cache based on IResimCacheBase (FEvolutionResimCache by default) that also caches particle collision constraints this is disabled by default since cached collisions will be wrong during a resimulation for particles that are desynced and particles that are in sync doesn't need collision data since we just step through their states in history."
Public function bool  
Protected function void  
Public function Const FGeometryParticle * Used as helper for GT to go from unique idx back to gt particle If GT deletes a particle, this function will return null (that's a good thing when consuming async outputs as GT may have already deleted the particle we care about) Note: if the physics solver has been advanced after the particle was freed on GT, the index may have been freed and reused.
Public function void  
Public function void  
Public function void Ensures that any running tasks finish.

Operators

  Type Name Description
Protected function FPhysicsSolverBase &

operator= ( const FPhysicsSolverBase& InCopy
)

  
Protected function FPhysicsSolverBase &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page