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

Light Theme

Dark Theme

FPBDRigidsSOAs

Windows

MacOS

Linux

References

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

Syntax

class FPBDRigidsSOAs

Constructors

	Name	Description
	FPBDRigidsSOAs()
	FPBDRigidsSOAs ( const FPBDRigidsSOAs& )
	FPBDRigidsSOAs ( FPBDRigidsSOAs&& Other )

Destructors

	Name	Description
	~FPBDRigidsSOAs()

Functions

	Name	Description
bool	ActivateParticle ( FGeometryParticleHandle* Parti... )	Wake a sleeping dynamic non-disabled particle.
void	ActivateParticles ( const TArray< FGeometryParticleHand... )	Wake multiple dynamic non-disabled particles.
void	ClearTransientDirty()
TArray< FPBD...	CreateClusteredParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FPBDRigidParticleParameters&... )	Used specifically by PBDRigidClustering.
TArray< FPBD...	CreateDynamicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FPBDRigidParticleParameters&... )
TArray< TPBD...	CreateGeometryCollectionParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FPBDRigidParticleParameters&... )
TArray< FKin...	CreateKinematicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FKinematicGeometryParticlePar... )
TArray< FGeo...	CreateStaticParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const FGeometryParticleParameters&... )
void	DeactivateParticle ( FGeometryParticleHandle* Parti..., const bool DeferUpdateViews )	Put a non-disabled dynamic particle to sleep.
void	DeactivateParticles ( const TArray< FGeometryParticleHand... )	Put multiple dynamic non-disabled particles to sleep.
void	DestroyParticle ( FGeometryParticleHandle* Parti... )
void	DisableParticle ( FGeometryParticleHandle* Parti... )	A disabled particle is ignored by the solver.
void	EnableParticle ( FGeometryParticleHandle* Parti... )
const auto &	GetActiveClusteredArray()	TEMP: only needed while clustering code continues to use direct indices.
TParticleVie...	GetActiveKinematicParticlesView()
const TParti...	GetActiveKinematicParticlesView()
TParticleVie...	GetActiveParticlesView()
const TParti...	GetActiveParticlesView()
TParticleVie...	GetActiveStaticParticlesView()
const TParti...	GetActiveStaticParticlesView()
const TParti...	GetAllParticlesView()
const auto &	GetClusteredParticles()
auto &	GetClusteredParticles()
const TParti...	GetDirtyParticlesView()
TParticleVie...	GetDirtyParticlesView()
const FPBDRi...	GetDynamicParticles()
FPBDRigidPar...	GetDynamicParticles()
const TPBDGe...	GetGeometryCollectionParticles()
TPBDGeometry...	GetGeometryCollectionParticles()
const auto &	GetNonDisabledClusteredArray()
const TParti...	GetNonDisabledDynamicView()
const FGeome...	GetNonDisabledStaticParticles()
FGeometryPar...	GetNonDisabledStaticParticles()
const TParti...	GetNonDisabledView()
TGeometryPar...	GetParticleHandles()
const TGeome...	GetParticleHandles()
auto &	GetUniqueIndices()
void	MarkTransientDirtyParticle ( FGeometryParticleHandle* Parti... )
void	Reset()
void	Serialize ( FChaosArchive& Ar )
void	SetDynamicParticleSOA ( FPBDRigidParticleHandle* Parti... )
void	UpdateGeometryCollectionViews ( const bool ForceUpdateViews )	Update which particle arrays geometry collection particles are in based on their object state (static, kinematic, dynamic, sleeping) and their disabled state.
void	UpdateIfNeeded()

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

Take our survey

Dismiss