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

Light Theme

Dark Theme

TPBDRigidClustering

PDBRigidClustering

Windows

MacOS

Linux

References

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

Syntax

template<class FPBDRigidEvolution, class FPBDCollisionConstraint, class T, int d>
class TPBDRigidClustering

Remarks

PDBRigidClustering

Constructors

	Name	Description
	TPBDRigidClustering ( FPBDRigidEvolution& InEvolution, TPBDRigidClusteredParticles< T, d >... )

Destructors

	Name	Description
	~TPBDRigidClustering()

Functions

	Name	Description
void	AddToClusterUnion ( int32 ClusterID, TPBDRigidClusteredParticleHandle< T... )
void	AdvanceClustering ( const T dt, FPBDCollisionConstraint& Collision... )	Operational AdvanceClustering Advance the cluster forward in time; ...
TMap< TPBDRi...	BreakingModel ( TMap< TGeometryParticleHandle< T, d... )	BreakingModel Implements the promotion breaking model, where strain impulses are summed onto the cluster body, and released if greater than the encoded strain.
void	ComputeStrainFromCollision ( const FPBDCollisionConstraint& Col... )
void	ConnectNodes ( TPBDRigidClusteredParticleHandle< T..., TPBDRigidClusteredParticleHandle< T... )
void	ConnectNodes ( TPBDRigidParticleHandle< T, d >..., TPBDRigidParticleHandle< T, d >... )
Chaos::TPBDR...	CreateClusterParticle ( const int32 ClusterGroupIndex, TArray< Chaos::TPBDRigidParticleHan..., const FClusterCreationParameters< T..., TSharedPtr< Chaos::FImplicitObject,..., const TRigidTransform< T, d >*... )	Initialization Initialize a cluster with the specified children.
Chaos::TPBDR...	CreateClusterParticleFromClusterChildren ( TArray< TPBDRigidParticleHandle< T,..., TPBDRigidClusteredParticleHandle< T..., const TRigidTransform< T, d >& Clu..., const FClusterCreationParameters< T... )	CreateClusterParticleFromClusterChildren Children : Rigid body ID to include in the cluster.
TSet< TPBDRi...	DeactivateClusterParticle ( TPBDRigidClusteredParticleHandle< T... )	Releasing DeactivateClusterParticle Release all the particles within the cluster particle
void	DisableCluster ( TPBDRigidClusteredParticleHandle< T... )
void	DisableParticleWithBreakEvent ( Chaos::TPBDRigidParticleHandle< flo... )
void	FixConnectivityGraphUsingDelaunayTriangulation ( Chaos::TPBDRigidClusteredParticleHa..., const FClusterCreationParameters< T... )
void	GenerateConnectionGraph ( Chaos::TPBDRigidClusteredParticleHa..., const FClusterCreationParameters< T... )
TPBDRigidPar...	GetActiveClusterIndex ( TPBDRigidParticleHandle< T, d >... )	GetActiveClusterIndex Get the current childs active cluster.
const TArray...	GetAllClusterBreakings()
const TClust...	GetBufferedData()	Access
FClusterMap ...	GetChildrenMap()	GetParentToChildren The parent to children map stores the currently active cluster ids (Particle Indices) as the keys of the map.
const FClust...	GetChildrenMap()
const TArray...	GetChildToParentMap()	GetChildToParentMap This map stores the relative transform from a child to its cluster parent.
TArrayCollec...	GetClusterGroupIndexArray()	GetClusterGroupIndexArray The group index is used to automatically bind disjoint clusters.
const TArray...	GetClusterIdsArray()
TArrayCollec...	GetClusterIdsArray()	GetClusterIdsArray The cluster ids provide a mapping from the rigid body index to its parent cluster id.
const TArray...	GetConnectivityEdges()	GetConnectivityEdges Provides a list of each rigid body's current siblings and associated strain within the cluster.
const TArray...	GetInternalClusterArray()	GetInternalClusterArray The internal cluster array indicates if this cluster was generated internally and would no be owned by an external source.
const TArray...	GetMultiChildProxyDataArray()	If multi child proxy is used, this is the data needed
const TArray...	GetMultiChildProxyIdArray()	Indicates if the child geometry is approximated by a single proxy
TArrayCollec...	GetStrainArray()	GetStrainArray The strain array is used to store the maximum strain allowed for a individual body in the simulation.
TSet< Chaos:...	GetTopLevelClusterParents()
const TSet< ...	GetTopLevelClusterParents()
T	PromoteStrains ( TPBDRigidParticleHandle< T, d >... )	PromoteStrains Sums the strains based on the cluster hierarchy.
void	ReleaseBufferedData()
TSet< TPBDRi...	ReleaseClusterParticles ( TPBDRigidClusteredParticleHandle< T..., const TMap< TGeometryParticleHandle..., bool bForceRelease )	ReleaseClusterParticles (BasedOnStrain) Release clusters based on the passed in `ExternalStrainArray_, or the particle handle's current` CollisionImpulses()_ value.
TSet< TPBDRi...	ReleaseClusterParticles ( TArray< TPBDRigidParticleHandle< T,... )	ReleaseClusterParticles Release all rigid body IDs passed,
void	RemoveNodeConnections ( TPBDRigidClusteredParticleHandle< T... )
void	RemoveNodeConnections ( TPBDRigidParticleHandle< T, d >... )
void	ResetAllClusterBreakings()
void	ResetCollisionImpulseArray()
void	SetClusterConnectionFactor ( float ClusterConnectionFactorIn )	GenerateConnectionGraph Creates a connection graph for the given index using the creation parameters.
void	SetClusterUnionConnectionType ( typename FClusterCreationParameters... )
void	SetGenerateClusterBreaking ( bool DoGenerate )
void	SwapBufferedData()
void	UnionClusterGroups()	UnionClusterGroups Clusters that share a group index should be unioned into a single cluster prior to simulation.
void	UpdateConnectivityGraphUsingDelaunayTriangulation ( Chaos::TPBDRigidClusteredParticleHa..., const FClusterCreationParameters< T... )
void	UpdateConnectivityGraphUsingPointImplicit ( Chaos::TPBDRigidClusteredParticleHa..., const FClusterCreationParameters< T... )	Connectivity
void	UpdateGeometry ( Chaos::TPBDRigidClusteredParticleHa..., const TSet< TPBDRigidParticleHandle..., TSharedPtr< Chaos::FImplicitObject,..., const FClusterCreationParameters< T... )
void	UpdateKinematicProperties ( Chaos::TPBDRigidParticleHandle< flo... )	Process the kinematic state of the clusters.
void	UpdateMassProperties ( Chaos::TPBDRigidClusteredParticleHa..., TSet< TPBDRigidParticleHandle< T, d..., const TRigidTransform< T, d >*... )	Ryan - do we still need this? void InitTopLevelClusterParents(const int32 StartIndex) { if (!StartIndex) { TopLevelClusterParents.Reset(); } for (uint32 i = StartIndex; i < MParticles.Size(); ++i) { if (MParticles.ClusterIds(i).Id == INDEX_NONE && !MParticles.Disabled(i)) { TopLevelClusterParents.Add(i); } } }

Typedefs

Name	Description
FClusterMap	Parent to children
FCollisionConstraintHandle
FPointContactConstraint

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

Take our survey

Dismiss