Navigation
API > API/Runtime > API/Runtime/Chaos
References
| Module | Chaos |
| Header | /Engine/Source/Runtime/Experimental/Chaos/Public/ChaosSolversModule.h |
| Include | #include "ChaosSolversModule.h" |
Syntax
class FChaosSolversModule
Constructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| Chaos::FPBDRigidsSolver * | CreateSolver
(
UObject* InOwner, |
Create a new solver state storage object to contain a solver and proxy storage object. | |
| void | DestroySolver
(
Chaos::FPhysicsSolverBase* InState |
Shuts down and destroys a solver state | |
| void | DumpHierarchyStats
(
int32* OutOptMaxCellElements |
Outputs statistics for the solver hierarchies. | |
| const TArray< Chaos::FPhysicsSolverBase * > & | Retrieve the list of all extant solvers. This contains all owned, unowned and standalone solvers | ||
| Chaos::FPersistentPhysicsTask * | Gets the inner physics thread task if it has been spawned. | ||
| FChaosSolversModule * | GetModule () |
||
| const IChaosSettingsProvider & | Safe method for always getting a settings provider (from the external caller or an internal default) | ||
| UClass * | |||
| void | 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< const Chaos::FPhysicsSolverBase * > | 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< Chaos::FPhysicsSolverBase * > | 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, |
Non-const access to the solver array is private - only the module should ever modify the storage lists | |
| void | GetSolverUpdatePrerequisites
(
FGraphEventArray& InPrerequisiteContainer |
Gets a list of pending prerequisites required before proceeding with a solver update | |
| void | Initialize () |
||
| bool | Queries for multithreaded configurations | ||
| bool | |||
| bool | IsValidSolverActorClass
(
UClass* Class |
||
| void | LockSolvers () |
||
| void | MigrateSolver
(
Chaos::FPhysicsSolverBase* InSolver, |
||
| 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 | |||
| void | Resume solvers. | ||
| void | SetSettingsProvider
(
IChaosSettingsProvider* InProvider |
||
| void | SetSolverActorClass
(
UClass* InActorClass, |
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 | |||
| void | Single-step advance solvers. | ||
| void | |||
| void | SyncTask
(
bool bForceBlockingSync |
Called to request a sync between the game thread and the currently running physics task | |
| void |