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
FGraphEventRef	AccelerationStructureTaskComplete
FPendingSpatial...	AsyncAccelerationQueue	Pending operations for the acceleration structures being rebuilt asynchronously
TUniquePtr< FAc...	AsyncExternalAcceleration
TUniquePtr< FAc...	AsyncInternalAcceleration
bool	bExternalReady
bool	bIsSingleThreaded
TArrayCollectio...	Collided
FPBDConstraintG...	ConstraintGraph
TArray< FPBDCon...	ConstraintRules
FPendingSpatial...	ExternalAccelerationQueue	Pending operations for the external acceleration structure
TArray< FForceR...	ForceRules
TArray< FForceR...	ImpulseRules
TUniquePtr< FAc...	InternalAcceleration
FPendingSpatial...	InternalAccelerationQueue	Pending operations for the internal acceleration structure
FKinematicUpdat...	KinematicUpdate
int32	NumIterations
int32	NumPushOutIterations
TArrayCollectio...	ParticleDisableCount
TPBDRigidsSOAs<...	Particles
TArrayAsMap< FU...	ParticleToCacheInnerIdx	Void SerializePendingMap(FChaosArchive& Ar, TMap, FPendingSpatialData>& 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
TArrayCollectio...	PerParticlePhysicsMaterials
TArrayCollectio...	PhysicsMaterials
TArray< FPBDCon...	PrioritizedConstraintRules
TUniquePtr< FAc...	ScratchExternalAcceleration
TMap< FSpatialA...	SpatialAccelerationCache
TUniquePtr< ISp...	SpatialCollectionFactory

Constructors

	Name	Description
	FPBDRigidsEvolutionBase ( TPBDRigidsSOAs< FReal, 3 >& InPart..., 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 )
void	ComputeIntermediateSpatialAcceleration ( bool bBlock )
TArray< TPBD...	CreateClusteredParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TPBDRigidParticleParameters< ... )
void	CreateConstraintGraph()
TArray< TPBD...	CreateDynamicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TPBDRigidParticleParameters< ... )
TArray< TPBD...	CreateGeometryCollectionParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TPBDRigidParticleParameters< ... )
void	CreateIslands()
TArray< TKin...	CreateKinematicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TKinematicGeometryParticlePar... )
void	CreateParticle ( TGeometryParticleHandle< FReal, 3 >... )
TArray< TGeo...	CreateStaticParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TGeometryParticleParameters< ... )
void	DestroyParticle ( TGeometryParticleHandle< FReal, 3 >... )
void	DirtyParticle ( TGeometryParticleHandleImp< FReal, ... )
void	DisableParticle ( TGeometryParticleHandle< FReal, 3 >... )
void	DisableParticles ( const TSet< TGeometryParticleHandle... )
void	DisableParticles ( TSet< TGeometryParticleHandle< FRea... )
void	EnableParticle ( TGeometryParticleHandle< FReal, 3 >..., const TGeometryParticleHandle< FRea... )
void	FlushAsyncAccelerationQueue()
void	FlushExternalAccelerationQueue ( FAccelerationStructure& Accelerati... )
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
FUniqueIdx	GenerateUniqueIdx()
const auto &	GetActiveClusteredArray()	TEMP: this is only needed while clustering continues to use indices directly.
FPBDConstrai...	GetConstraintGraph()
const FPBDCo...	GetConstraintGraph()
const TArray...	GetIslandParticles ( const int32 Island )
const auto &	GetNonDisabledClusteredArray()
const TGeome...	GetParticleHandles()
TGeometryPar...	GetParticleHandles()
const TPBDRi...	GetParticles()
TPBDRigidsSO...	GetParticles()
const TUniqu...	GetPerParticlePhysicsMaterial ( const TGeometryParticleHandle< FRea... )
TSerializabl...	GetPhysicsMaterial ( const TGeometryParticleHandle< FRea... )
ISpatialAcce...	GetSpatialAcceleration()
void	InitializeAccelerationStructures()
int32	NumConstraints()
int32	NumIslands()
void	PrepareConstraints ( const FReal Dt )
void	RebuildSpatialAccelerationForPerfTest()	Rebuilds the spatial acceleration from scratch. This should only be used for perf testing
void	RemoveConstraints ( const TSet< TGeometryParticleHandle... )
void	RemoveParticleFromAccelerationStructure ( TGeometryParticleHandleImp< FReal, ... )
void	ReserveParticles ( const int32 Num )	Preallocate buffers for creating `Num_ particles.
void	Serialize ( FChaosArchive& Ar )
void	SetNumIterations ( int32 InNumIterations )
void	SetNumPushOutIterations ( int32 InNumIterations )
void	SetParticleObjectState ( TPBDRigidParticleHandle< FReal, 3 >..., EObjectStateType ObjectState )
void	SetParticleUpdatePositionFunction ( FUpdatePositionRule ParticleUpdate )
void	SetParticleUpdateVelocityFunction ( FUpdateVelocityRule ParticleUpdate )
void	SetPerParticlePhysicsMaterial ( TGeometryParticleHandle< FReal, 3 >..., TUniquePtr< FChaosPhysicsMaterial >... )
void	SetPhysicsMaterial ( TGeometryParticleHandle< FReal, 3 >..., TSerializablePtr< FChaosPhysicsMate... )
void	UnprepareConstraints ( const FReal Dt )
void	UpdateAccelerationStructures ( int32 Island )
void	UpdateConstraintPositionBasedState ( FReal Dt )
void	UpdateExternalAccelerationStructure ( TUniquePtr< ISpatialAccelerationCol... )	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 )

Classes

	Name	Description
	FChaosAccelerationStructureTask
	FPendingSpatialData	Used for updating intermediate spatial structures when they are finished
	FPendingSpatialDataQueue

Typedefs

Name	Description
FAccelerationStructure
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