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 > FChaosSolversModule

Light Theme

Dark Theme

FChaosSolversModule

Windows

MacOS

Linux

References

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

Syntax

class FChaosSolversModule

Constructors

	Name	Description
	FChaosSolversModule()

Functions

	Name	Description
Chaos::FPBDR...	CreateSolver ( UObject* InOwner, Chaos::EThreadingMode ThreadingMode )	Create a new solver state storage object to contain a solver and proxy storage object.
void	DestroySolver ( Chaos::FPhysicsSolverBase* InS... )	Shuts down and destroys a solver state
void	DumpHierarchyStats ( int32* OutOptMaxCellElements )	Outputs statistics for the solver hierarchies.
const TArray...	GetAllSolvers()	Retrieve the master list of solvers. This contains all owned, unowned and standalone solvers
Chaos::FPers...	GetDedicatedTask()	Gets the inner physics thread task if it has been spawned.
FChaosSolver...	GetModule()
const IChaos...	GetSettingsProvider()	Safe method for always getting a settings provider (from the external caller or an internal default)
UClass *	GetSolverActorClass()
void	GetSolvers ( const UObject* InOwner, TArray< const Chaos::FPhysicsSolver... )	Read access to the current solver-state objects, be aware which thread owns this data when attempting to use this.
TArray< cons...	GetSolvers ( const UObject* InOwner )	Read access to the current solver-state objects, be aware which thread owns this data when attempting to use this.
TArray< Chao...	GetSolversMutable ( const UObject* InOwner )	Non-const access to the solver array is private - only the module should ever modify the storage lists
void	GetSolversMutable ( const UObject* InOwner, TArray< Chaos::FPhysicsSolverBase&... )	Non-const access to the solver array is private - only the module should ever modify the storage lists
void	GetSolverUpdatePrerequisites ( FGraphEventArray& InPrerequisiteCo... )	Gets a list of pending prerequisites required before proceeding with a solver update
void	Initialize()
bool	IsPersistentTaskEnabled()	Queries for multithreaded configurations
bool	IsPersistentTaskRunning()
bool	IsValidSolverActorClass ( UClass* Class )
void	LockSolvers()
void	MigrateSolver ( Chaos::FPhysicsSolverBase* InS..., const UObject* InNewOwner )
void	OnCreateMaterial ( Chaos::FMaterialHandle InHandle )
void	OnCreateMaterialMask ( Chaos::FMaterialMaskHandle InHandle )
void	OnDestroyMaterial ( Chaos::FMaterialHandle InHandle )
void	OnDestroyMaterialMask ( Chaos::FMaterialMaskHandle InHandle )
void	OnUpdateMaterial ( Chaos::FMaterialHandle InHandle )	Events that the material manager will emit for us to update our threaded data
void	OnUpdateMaterialMask ( Chaos::FMaterialMaskHandle InHandle )
void	PauseSolvers()	Pause solvers.
void	RegisterSolverActorClassProvider ( IChaosSolverActorClassProvider*... )
void	ResumeSolvers()	Resume solvers.
void	SetSettingsProvider ( IChaosSettingsProvider* InProv... )
void	SetSolverActorClass ( UClass* InActorClass, UClass* InActorRequiredBaseCla... )	Sets the actor type which should be AChaosSolverActor::StaticClass() but that is not accessible from engine.
bool	ShouldStepSolver ( int32& InOutSingleStepCounter )	Query whether a particular solver should advance and update its single-step counter. Thread safe.
void	Shutdown()
void	ShutdownModule()
void	SingleStepSolvers()	Single-step advance solvers.
void	StartupModule()
void	SyncTask ( bool bForceBlockingSync )	Called to request a sync between the game thread and the currently running physics task
void	UnlockSolvers()

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

Take our survey

Dismiss