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 > Engine > Physics > ImmediatePhysics > ImmediatePhysicsChaos > TPBDRigidsSOAs

Light Theme

Dark Theme

TPBDRigidsSOAs

Windows

MacOS

Linux

References

Module	Engine
Header	/Engine/Source/Runtime/Engine/Public/Physics/ImmediatePhysics/ImmediatePhysicsChaos/ImmediatePhysicsCore_Chaos.h
Include	#include "Physics/ImmediatePhysics/ImmediatePhysicsChaos/ImmediatePhysicsCore_Chaos.h"

Syntax

template<typename T, int d>
class TPBDRigidsSOAs

Constructors

	Name	Description
	TPBDRigidsSOAs()
	TPBDRigidsSOAs ( const TPBDRigidsSOAs< T, d >& )
	TPBDRigidsSOAs ( TPBDRigidsSOAs< T, d >&& Other )

Functions

	Name	Description
void	ActivateParticle ( TGeometryParticleHandle< T, d >... )	Wake a sleeping dynamic non-disabled particle.
void	ActivateParticles ( const TArray< TGeometryParticleHand... )	Wake multiple dynamic non-disabled particles.
TArray< TPBD...	CreateClusteredParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TPBDRigidParticleParameters< ... )	Used specifically by PBDRigidClustering.
TArray< TPBD...	CreateDynamicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TPBDRigidParticleParameters< ... )
TArray< TPBD...	CreateGeometryCollectionParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TPBDRigidParticleParameters< ... )
TArray< TKin...	CreateKinematicParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TKinematicGeometryParticlePar... )
TArray< TGeo...	CreateStaticParticles ( int32 NumParticles, const FUniqueIdx* ExistingIndi..., const TGeometryParticleParameters< ... )
void	DeactivateParticle ( TGeometryParticleHandle< T, d >..., const bool DeferUpdateViews )	Put a non-disabled dynamic particle to sleep.
void	DeactivateParticles ( const TArray< TGeometryParticleHand... )	Put multiple dynamic non-disabled particles to sleep.
void	DestroyParticle ( TGeometryParticleHandle< T, d >... )
void	DisableParticle ( TGeometryParticleHandle< T, d >... )	A disabled particle is ignored by the solver.
void	EnableParticle ( TGeometryParticleHandle< T, d >... )
const auto &	GetActiveClusteredArray()	TEMP: only needed while clustering code continues to use direct indices.
TParticleVie...	GetActiveKinematicParticlesView()
const TParti...	GetActiveKinematicParticlesView()
TParticleVie...	GetActiveParticlesView()
const TParti...	GetActiveParticlesView()
const TParti...	GetAllParticlesView()
auto &	GetClusteredParticles()
const auto &	GetClusteredParticles()
TPBDRigidPar...	GetDynamicParticles()
const TPBDRi...	GetDynamicParticles()
TPBDGeometry...	GetGeometryCollectionParticles()
const TPBDGe...	GetGeometryCollectionParticles()
const auto &	GetNonDisabledClusteredArray()
const TParti...	GetNonDisabledDynamicView()
TGeometryPar...	GetNonDisabledStaticParticles()
const TGeome...	GetNonDisabledStaticParticles()
const TParti...	GetNonDisabledView()
const TGeome...	GetParticleHandles()
TGeometryPar...	GetParticleHandles()
auto &	GetUniqueIndices()
void	Reset()
void	Serialize ( FChaosArchive& Ar )
void	SetDynamicParticleSOA ( TPBDRigidParticleHandle< T, d >... )
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