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

Light Theme

Dark Theme

FPBDRigidsEvolutionBase

Windows

MacOS

Linux

Inheritance Hierarchy

FPBDRigidsEvolutionGBF

References

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

Syntax

class FPBDRigidsEvolutionBase

Variables

	Name	Description
TArray< TUnique...	AccelerationBackingBuffer	The backing buffer for all acceleration structures
FGraphEventRef	AccelerationStructureTaskComplete
FPendingSpatial...	AsyncAccelerationQueue	Pending operations for the acceleration structures being rebuilt asynchronously
FAccelerationSt...	AsyncExternalAcceleration
FAccelerationSt...	AsyncInternalAcceleration
bool	bCanStartAsyncTasks	Allows us to tell evolution to stop starting async tasks if we are trying to cleanup solver/evo.
bool	bIsSingleThreaded
FCaptureRewindR...	CaptureRewindData
TArrayCollectio...	Collided
FPBDConstraintG...	ConstraintGraph
TArray< FPBDCon...	ConstraintRules
TQueue< FAccele...	ExternalStructuresPool	External thread will push into this when done with structure internal thread will pop from this to generate new structure
TQueue< FAccele...	ExternalStructuresQueue	Internal thread will push into this and external thread will consume
TArray< FForceR...	ForceRules
TArray< FForceR...	ImpulseRules
FAccelerationSt...	InternalAcceleration
FPendingSpatial...	InternalAccelerationQueue	Pending operations for the internal acceleration structure
TQueue< int32, ...	IslandsToWake
FKinematicUpdat...	KinematicUpdate
int32	LatestExternalTimestampConsumed_Internal	The latest external timestamp we consumed inputs from, assigned to evolution when solver task executes, is used to stamp output data.
int32	NumIterations
int32	NumPushOutIterations
TArrayCollectio...	ParticleDisableCount
FPBDRigidsSOAs ...	Particles
TArrayAsMap< FU...	ParticleToCacheInnerIdx	Void SerializePendingMap(FChaosArchive& Ar, TMap& Map) { TArray Keys; if (!Ar.IsLoading()) { Map.GenerateKeyArray(Keys); } Ar << AsAlwaysSerializableArray(Keys); for (auto Key : Keys) { FPendingSpatialData& PendingData = Map.FindOrAdd(Key); PendingData.Serialize(Ar); } /TODO: fix serialization } Used for async acceleration rebuild
FUpdatePosition...	ParticleUpdatePosition
FUpdateVelocity...	ParticleUpdateVelocity
TArray< FUnique...	PendingReleaseIndices
TArrayCollectio...	PerParticlePhysicsMaterials
TArrayCollectio...	PhysicsMaterials
TArray< FPBDCon...	PrioritizedConstraintRules
THandleArray< F...	SolverPhysicsMaterials
TMap< FSpatialA...	SpatialAccelerationCache
TUniquePtr< ISp...	SpatialCollectionFactory
TArray< FUnique...	UniqueIndicesPendingRelease

Constructors

	Name	Description
	FPBDRigidsEvolutionBase ( FPBDRigidsSOAs& InParticles, THandleArray< FChaosPhysicsMaterial..., int32 InNumIterations, int32 InNumPushOutIterations, bool InIsSingleThreaded )

Destructors

	Name	Description
	~FPBDRigidsEvolutionBase()

Functions

	Name	Description
void	AddConstraintRule ( FPBDConstraintGraphRule* Const... )
void	AddForceFunction ( FForceRule ForceFunction )
void	AddImpulseFunction ( FForceRule ImpulseFunction )
void	ApplyConstraints ( const FReal Dt, int32 Island )
void	ApplyKinematicTargets ( const FReal Dt, const FReal StepFraction )
void	ApplyParticlePendingData ( const FPendingSpatialData& Pending..., FAccelerationStructure& SpatialAcc..., bool bUpdateCache )
void	ApplyPushOut ( const FReal Dt, int32 Island )
bool	AreAnyTasksPending()
void	ComputeIntermediateSpatialAcceleration ( bool bBlock )	Ticks computation of acceleration structures.
TArray< TPBD...	CreateClusteredParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FPBDRigidParticleParameters&... )
void	CreateConstraintGraph()
TArray< FPBD...	CreateDynamicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FPBDRigidParticleParameters&... )
TArray< TPBD...	CreateGeometryCollectionParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FPBDRigidParticleParameters&... )
void	CreateIslands()
TArray< FKin...	CreateKinematicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FKinematicGeometryParticlePar... )
void	CreateParticle ( FGeometryParticleHandle* Parti... )
TArray< FGeo...	CreateStaticParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FGeometryParticleParameters&... )
void	DestroyParticle ( FGeometryParticleHandle* Parti... )
void	DirtyParticle ( TGeometryParticleHandleImp< FReal, ... )
void	DisableConstraints ( const TSet< FGeometryParticleHandle... )
void	DisableParticle ( FGeometryParticleHandle* Parti... )
void	DisableParticles ( const TSet< FGeometryParticleHandle... )
void	DisableParticles ( TSet< FGeometryParticleHandle*... )
void	EnableParticle ( FGeometryParticleHandle* Parti..., const FGeometryParticleHandle*... )
void	FlushAsyncAccelerationQueue()
void	FlushExternalAccelerationQueue ( FAccelerationStructure& Accelerati..., FPendingSpatialDataQueue& External... )
void	FlushInternalAccelerationQueue()
void	FlushSpatialAcceleration()	Perform a blocking flush of the spatial acceleration structure for situations where we aren't simulating but must have an up to date structure
void	FreeSpatialAcceleration_External ( FAccelerationStructure* Struct... )
FUniqueIdx	GenerateUniqueIdx()
const auto &	GetActiveClusteredArray()	TEMP: this is only needed while clustering continues to use indices directly.
const FPBDCo...	GetConstraintGraph()
FPBDConstrai...	GetConstraintGraph()
FAcceleratio...	GetFreeSpatialAcceleration_Internal()
const TArray...	GetIslandParticles ( const int32 Island )
const auto &	GetNonDisabledClusteredArray()
int32	GetNumIterations()
int32	GetNumPushOutIterations()
const TGeome...	GetParticleHandles()
TGeometryPar...	GetParticleHandles()
const FPBDRi...	GetParticles()
FPBDRigidsSO...	GetParticles()
const TUniqu...	GetPerParticlePhysicsMaterial ( const FGeometryParticleHandle*... )
TSerializabl...	GetPhysicsMaterial ( const FGeometryParticleHandle*... )
ISpatialAcce...	GetSpatialAcceleration()
void	InitializeAccelerationStructures()
int32	NumConstraints()
int32	NumIslands()
void	PrepareIteration ( const FReal Dt )
void	PrepareTick()
void	RebuildSpatialAccelerationForPerfTest()	Rebuilds the spatial acceleration from scratch. This should only be used for perf testing
void	ReleaseIdx ( FUniqueIdx Idx )
void	ReleasePendingIndices()
void	RemoveParticleFromAccelerationStructure ( TGeometryParticleHandleImp< FReal, ... )
void	ReserveParticles ( const int32 Num )	Preallocate buffers for creating `Num_ particles.
void	ResetConstraints()
void	Serialize ( FChaosArchive& Ar )
void	SetCanStartAsyncTasks ( bool bInCanStartAsyncTasks )
void	SetCaptureRewindDataFunction ( FCaptureRewindRule Rule )
void	SetNumIterations ( int32 InNumIterations )
void	SetNumPushOutIterations ( int32 InNumIterations )
void	SetParticleObjectState ( FPBDRigidParticleHandle* Parti..., EObjectStateType ObjectState )
void	SetParticleUpdatePositionFunction ( FUpdatePositionRule ParticleUpdate )
void	SetParticleUpdateVelocityFunction ( FUpdateVelocityRule ParticleUpdate )
void	SetPerParticlePhysicsMaterial ( FGeometryParticleHandle* Parti..., TUniquePtr< FChaosPhysicsMaterial >... )
void	SetPhysicsMaterial ( FGeometryParticleHandle* Parti..., TSerializablePtr< FChaosPhysicsMate... )
void	UnprepareIteration ( const FReal Dt )
void	UnprepareTick()
void	UpdateAccelerationStructures ( int32 Island )
void	UpdateConstraintPositionBasedState ( FReal Dt )
void	UpdateExternalAccelerationStructure_External ( ISpatialAccelerationCollection< FAc..., FPendingSpatialDataQueue& PendingE... )	Make a copy of the acceleration structure to allow for external modification.
void	UpdateVelocities ( const FReal Dt, int32 Island )
void	WaitOnAccelerationStructure()
void	WakeIsland ( const int32 Island )
void	WakeIslands()

Classes

	Name	Description
	FChaosAccelerationStructureTask

Typedefs

Name	Description
FAccelerationStructure
FCaptureRewindRule
FForceRule
FKinematicUpdateRule
FUpdatePositionRule
FUpdateVelocityRule

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

Take our survey

Dismiss