Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Chaos > Chaos > Framework > FPhysicsSolverBase

Light Theme

Dark Theme

FPhysicsSolverBase

Windows

MacOS

Linux

Inheritance Hierarchy

FPhysicsSolverBase

FPBDRigidsSolver

References

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

Syntax

class FPhysicsSolverBase

Variables

	Name	Description
EMultiBufferMod...	BufferMode	Mode that the results buffers should be set to (single, double, triple)
bool	bUseCollisionResimCache
TArray< ISimCal...	ContactModifiers
FSolverPostAdva...	EventPostSolve
FSolverPreBuffe...	EventPreBuffer
FSolverPreAdvan...	EventPreSolve	Storage for events, see the Add/Remove pairs above for event timings
FChaosMarshalli...	MarshallingManager
TUniquePtr< IRe...	MRewindCallback
TUniquePtr< FRe...	MRewindData
TUniquePtr< FPe...	PendingSpatialOperations_External	The spatial operations not yet consumed by the internal sim. Use this to ensure any GT operations are seen immediately.
FGraphEventRef	PendingTasks
TUniquePtr< FCh...	PullResultsManager
TArray< ISimCal...	SimCallbackObjects
EThreadingModeT...	ThreadingMode

Constructors

	Name	Description
	FPhysicsSolverBase()
	FPhysicsSolverBase ( const FPhysicsSolverBase& InCopy )
	FPhysicsSolverBase ( FPhysicsSolverBase&& InSteal )
	FPhysicsSolverBase ( const EMultiBufferMode BufferingMod..., const EThreadingModeTemp InThreadin..., UObject* InOwner )	Protected construction so callers still have to go through the module to create new instances

Destructors

	Name	Description
	~FPhysicsSolverBase()	Only allow construction with valid parameters as well as restricting to module construction

Functions

	Name	Description
void	AddDirtyProxiesUnsafe ( TProxiesArray& ProxiesArray )	Batch dirty proxies without checking DirtyIdx.
void	AddDirtyProxy ( IPhysicsProxyBase* ProxyBaseIn )
void	AddDirtyProxyShape ( IPhysicsProxyBase* ProxyBaseIn, int32 ShapeIdx )
FDelegateHan...	AddPostAdvanceCallback ( FSolverPostAdvance::FDelegate InDel... )	Post advance happens after all processing and results generation has been completed
FDelegateHan...	AddPreAdvanceCallback ( FSolverPreAdvance::FDelegate InDele... )	Events Pre advance is called before any physics processing or simulation happens in a given physics update
FDelegateHan...	AddPreBufferCallback ( FSolverPreAdvance::FDelegate InDele... )	Pre buffer happens after the simulation has been advanced (particle positions etc. will have been updated) but GT results haven't been prepared yet
FGraphEventR...	AdvanceAndDispatch_External ( FReal InDt )
void	AdvanceSolverBy ( const FReal Dt, const FSubStepInfo& SubStepInfo )
void	ApplyCallbacks_Internal ( const FReal SimTime, const FReal Dt )
bool	AreAnyTasksPending()
FPBDRigidsSo...	CastChecked()
void	CastHelper ( const Lambda& Func )
void	ChangeBufferMode ( EMultiBufferMode InBufferMode )
void	ClearGTParticle_External ( FGeometryParticle& Particle )
void	ConditionalApplyRewind_Internal()
TSimCallback...	CreateAndRegisterSimCallbackObject_External ( bool bContactModification )	Creates a new sim callback object of the type given.
void	DestroySolver ( FPhysicsSolverBase& InSolver )
void	DisableAsyncMode()
void	EnableAsyncMode ( FReal FixedDt )
void	EnableRewindCapture ( int32 NumFrames, bool InUseCollisionResimCache, TUniquePtr< IRewindCallback >&& Re... )
void	EnqueueCommandImmediate ( Lambda&& Func )
void	FinalizeCallbackData_Internal()
FPhysicsScen...	GetExternalDataLock_External()	Get the lock used for external data manipulation.
FChaosMarsha...	GetMarshallingManager()
const UObjec...	GetOwner()
FReal	GetPhysicsResultsTime_External()	Returns the time used by physics results. If fixed dt is used this will be the interpolated time
IRewindCallb...	GetRewindCallback()
FRewindData ...	GetRewindData()
EThreadingMo...	GetThreadingMode()
bool	IsPaused_External()
bool	IsPendingTasksComplete()
bool	IsShuttingDown()
bool	IsUsingAsyncResults()
bool	IsUsingFixedDt()
void	MarkShuttingDown()
void	PopAndExecuteStolenAdvanceTask_ForTesting()
void	ProcessPushedData_Internal ( FPushPhysicsData& PushDataArray )
void	PullPhysicsStateForEachDirtyProxy_External ( const RigidLambda& RigidFunc )	Pulls physics state for each dirty particle and allows caller to do additional work if needed.
void	PushPhysicsState ( const FReal Dt, const int32 NumSteps, const int32 NumExternalSteps )
void	RegisterSimOneShotCallback ( Lambda&& Func )
void	RemoveDirtyProxy ( IPhysicsProxyBase* ProxyBaseIn )
bool	RemovePostAdvanceCallback ( FDelegateHandle InHandle )
bool	RemovePreAdvanceCallback ( FDelegateHandle InHandle )
bool	RemovePreBufferCallback ( FDelegateHandle InHandle )
void	SetExternalTimestampConsumed_Internal ( const int32 Timestamp )
void	SetIsPaused_External ( bool bShouldPause )
void	SetNumDirtyShapes ( IPhysicsProxyBase* Proxy, int32 NumShapes )
void	SetOwner ( const UObject* InOwner )
void	SetRewindCallback ( TUniquePtr< IRewindCallback >&& Re... )
void	SetStealAdvanceTasks_ForTesting ( bool bInStealAdvanceTasksForTesting )
void	SetThreadingMode_External ( EThreadingModeTemp InThreadingMode )
void	TrackGTParticle_External ( FGeometryParticle& Particle )
FGeometryPar...	UniqueIdxToGTParticle_External ( const FUniqueIdx& UniqueIdx )	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) In this case instead of getting a nullptr you will get an unrelated (wrong) GT particle Because of this we keep the index alive for as long as the async callback can lag behind.
void	UnregisterAndFreeSimCallbackObject_External ( ISimCallbackObject* SimCallbac... )
void	UpdateParticleInAccelerationStructure_External ( FGeometryParticle* Particle, bool bDelete )
void	WaitOnPendingTasks_External()	Ensures that any running tasks finish.

Operators

		Name	Description
	FPhysicsSolv...	operator= ( FPhysicsSolverBase&& InSteal )
	FPhysicsSolv...	operator= ( const FPhysicsSolverBase& InCopy )

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss