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

Light Theme

Dark Theme

TPBDRigidClustering::ReleaseClusterParticles

ReleaseClusterParticles (BasedOnStrain) Release clusters based on the passed in `ExternalStrainArray_, or the particle handle's current `CollisionImpulses()_ value.

Windows

MacOS

Linux

References

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

Syntax

TSet< FPBDRigidParticleHandle * > ReleaseClusterParticles
(
    FPBDRigidClusteredParticleHandle * ClusteredParticle,
    const TMap< FGeometryParticleHandle *, FReal > * ExternalStrainMap,
    bool bForceRelease
)

Remarks

ReleaseClusterParticles (BasedOnStrain) Release clusters based on the passed in ExternalStrainArray_, or the particle handle's current CollisionImpulses()_ value. Any cluster bodies that have a strain value less than this valid will be released from the cluster.

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

Take our survey

Dismiss