1. Epic GamesDeveloper
  3. FChaosSolversModule

FChaosSolversModule

Unreal Engine C++ API Reference > 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
Public function    

Functions

  Type Name Description
Public function Chaos::FPBDRigidsSolver *

CreateSolver ( UObject* InOwner,
Chaos::FReal InAsyncDt,
Chaos::EThreadingMode ThreadingMode
)

 Create a new solver state storage object to contain a solver and proxy storage object.
Public function void Shuts down and destroys a solver state
Public function void

DumpHierarchyStats ( int32* OutOptMaxCellElements
)

 Outputs statistics for the solver hierarchies.
Public function Const const TArray< Chaos::FPhysicsSolverBase * > & Retrieve the list of all extant solvers. This contains all owned, unowned and standalone solvers
Public function Const Chaos::FPersistentPhysicsTask * Gets the inner physics thread task if it has been spawned.
Public function Static FChaosSolversModule *  
Public function Const const IChaosSettingsProvider & Safe method for always getting a settings provider (from the external caller or an internal default)
Public function Const UClass *  
Public function Const void

GetSolvers ( const UObject* InOwner,
TArray< const Chaos::FPhysicsSolverBase* >& OutSolvers
)

 Read access to the current solver-state objects, be aware which thread owns this data when attempting to use this.
Public function Const 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.
Public function 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
Public function void

GetSolversMutable ( const UObject* InOwner,
TArray< Chaos::FPhysicsSolverBase* >& OutSolvers
)

 Non-const access to the solver array is private - only the module should ever modify the storage lists
Public function void

GetSolverUpdatePrerequisites ( FGraphEventArray& InPrerequisiteContainer
)

 Gets a list of pending prerequisites required before proceeding with a solver update
Public function void  
Public function Const bool Queries for multithreaded configurations
Public function Const bool  
Public function Const bool  
Public function void  
Public function void

MigrateSolver ( Chaos::FPhysicsSolverBase* InSolver,
const UObject* InNewOwner
)

  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void Events that the material manager will emit for us to update our threaded data
Public function void  
Public function void Pause solvers.
Public function void  
Public function void Resume solvers.
Public function void  
Public function void

SetSolverActorClass ( UClass* InActorClass,
UClass* InActorRequiredBaseClass
)

 Sets the actor type which should be AChaosSolverActor::StaticClass() but that is not accessible from engine.
Public function Const bool

ShouldStepSolver ( int32& InOutSingleStepCounter
)

 Query whether a particular solver should advance and update its single-step counter. Thread safe.
Public function void  
Public function void  
Public function void Single-step advance solvers.
Public function void  
Public function void

SyncTask ( bool bForceBlockingSync
)

 Called to request a sync between the game thread and the currently running physics task
Public function void  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page