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

Light Theme

Dark Theme

FPBDRigidsSolver

Windows

MacOS

Linux

Inheritance Hierarchy

FPhysicsSolverBase

FPBDRigidsSolver

References

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

Syntax

class FPBDRigidsSolver : public Chaos::FPhysicsSolverBase

Variables

		Name	Description
	void *	PhysSceneHack

Constructors

No constructors are accessible with public or protected access.

Destructors

No destructors are accessible with public or protected access.

Functions

	Name	Description
void	AddParticleToProxy ( const Chaos::FGeometryParticleHandl..., IPhysicsProxyBase* Proxy )
void	ApplyConfig ( const FChaosSolverConfiguration& I... )	Apply a solver configuration to this solver, set externally by the owner of a solver (see UPhysicsSettings for world solver settings)
void	BeginDestroy()
void	ChangeBufferMode ( Chaos::EMultiBufferMode InBufferMod... )	Execution API
void	CompleteSceneSimulation()
void	CreateMaterial ( Chaos::FMaterialHandle InHandle, const Chaos::FChaosPhysicsMaterial ... )
void	CreateMaterialMask ( Chaos::FMaterialMaskHandle InHandle, const Chaos::FChaosPhysicsMaterialM... )
void	DestroyMaterial ( Chaos::FMaterialHandle InHandle )
void	DestroyMaterialMask ( Chaos::FMaterialMaskHandle InHandle )
void	FieldForcesUpdateCallback()	Update the particles forces based on field evaluation
void	FieldParameterUpdateCallback ( Chaos::FPBDPositionConstraints& Po..., TMap< int32, int32 >& TargetedPart... )	Update the particles parameters based on field evaluation
void	FinalizeRewindData ( const TParticleView< FPBDRigidParti... )
int32 &	GetCurrentFrame()
FDirtyPartic...	GetDirtyParticlesBuffer()	Simulation API
FSolverEvent...	GetEventFilters()
FSolverEvent...	GetEventFilters()
FEventManage...	GetEventManager()
FPBDRigidsEv...	GetEvolution()
FPBDRigidsEv...	GetEvolution()
TArray< FGeo...	GetGeometryCollectionPhysicsProxies_Internal()
const FJoint...	GetJointConstraints()
FJointConstr...	GetJointConstraints()
FReal	GetLastDt()
FReal	GetMaxDeltaTime()
int32	GetMaxSubSteps()
FReal	GetMinDeltaTime()
const FParti...	GetParticles()
FParticlesTy...	GetParticles()
const FPerSo...	GetPerSolverField()
FPerSolverFi...	GetPerSolverField()
const TSet< ...	GetProxies ( const Chaos::FGeometryParticleHandl... )
const THandl...	GetQueryMaterialMasks_External()
const THandl...	GetQueryMaterials_External()	Access to the internal material mirrors
const THandl...	GetSimMaterialMasks()
const THandl...	GetSimMaterials()
FReal &	GetSolverTime()
const FReal	GetSolverTime()
FPBDSuspensi...	GetSuspensionConstraints()
const FPBDSu...	GetSuspensionConstraints()
int32	NumCollisionConstraints()
int32	NumJointConstraints()
void	PostEvolutionVDBPush()	Visual debugger (VDB) push methods.
void	PostTickDebugDraw ( FReal Dt )
void	RegisterObject ( FGeometryCollectionPhysicsProxy... )
void	RegisterObject ( Chaos::FJointConstraint* GTCon... )
void	RegisterObject ( Chaos::FSuspensionConstraint* ... )
void	RegisterObject ( FSingleParticlePhysicsProxy* P... )	Object API
void	RemoveParticleToProxy ( const Chaos::FGeometryParticleHandl... )
void	Reset()
bool	RewindUsesCollisionResimCache()
void	SetBreakingFilterSettings ( const FSolverBreakingFilterSettings... )
void	SetCollisionCullDistance ( const FReal InCullDistance )
void	SetCollisionFilterSettings ( const FSolverCollisionFilterSetting... )
void	SetCollisionPairIterations ( const int32 InNumIterations )
void	SetCollisionPushOutPairIterations ( const int32 InNumIterations )
void	SetCurrentFrame ( const int32 CurrentFrameIn )
void	SetGenerateBreakingData ( bool bDoGenerate )
void	SetGenerateCollisionData ( bool bDoGenerate )
void	SetGenerateTrailingData ( bool bDoGenerate )
void	SetIterations ( const int32 InNumIterations )
void	SetJointPairIterations ( const int32 InNumIterations )
void	SetJointPushOutPairIterations ( const int32 InNumIterations )
void	SetMaxDeltaTime ( const FReal InMaxDeltaTime )
void	SetMaxSubSteps ( const int32 InMaxSubSteps )
void	SetPushOutIterations ( const int32 InNumIterations )
void	SetTrailingFilterSettings ( const FSolverTrailingFilterSettings... )
void	SetUseContactGraph ( const bool bInUseContactGraph )
void	StartingSceneSimulation()
void	SyncEvents_GameThread()
void	SyncQueryMaterials_External()	Copy the simulation material list to the query material list, to be done when the SQ commits an update
void	UnregisterObject ( FGeometryCollectionPhysicsProxy... )
void	UnregisterObject ( FSingleParticlePhysicsProxy* P... )
void	UnregisterObject ( Chaos::FJointConstraint* GTCon... )
void	UnregisterObject ( Chaos::FSuspensionConstraint* ... )
void	UpdateCounters()
void	UpdateExternalAccelerationStructure_External ( ISpatialAccelerationCollection< FAc... )
void	UpdateGameThreadStructures()
void	UpdateMaterial ( Chaos::FMaterialHandle InHandle, const Chaos::FChaosPhysicsMaterial ... )	Events hooked up to the Chaos material manager
void	UpdateMaterialMask ( Chaos::FMaterialMaskHandle InHandle, const Chaos::FChaosPhysicsMaterialM... )

Overridden from FPhysicsSolverBase

		Name	Description
	bool	AreAnyTasksPending()

Typedefs

Name	Description
FDirtyParticlesBuffer
FHandle
FJointConstraintRule
FJointConstraints
FJointConstraintsRule
FParticle
FParticlesType
FPBDRigidsEvolution
FPositionConstraints
FPositionConstraintsRule
FRigidDynamicSpringConstraints
FRigidDynamicSpringConstraintsRule
FSuspensionConstraintsRule
Super

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

Take our survey

Dismiss