1. Epic GamesDeveloper
  3. FRigidClustering

FRigidClustering

Unreal Engine C++ API Reference > Runtime > Chaos > Chaos

References

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

Syntax

class FRigidClustering

Constructors

  Type Name Description
Public function  

FRigidClustering ( FRigidEvolution& InEvolution,
FPBDRigidClusteredParticles& InParticles,
const TArray< ISimCallbackObject* >* InStrainModifiers
)

  

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void Manually add a set of particles to a cluster after the cluster has already been created.
Public function void

AdvanceClustering ( const FReal dt,
FPBDCollisionConstraints& CollisionRule
)

 Operational AdvanceClustering Advance the cluster forward in time; ...
Protected function void  
Public function bool BreakCluster Breaks a cluster (internal or not) by applying max external strain to all its children
Public function bool BreakClustersByProxy Breaks clusters (internal or not) own by a specific proxy by applying max external strain to all its children
Public function void BreakingModel Implements the promotion breaking model, where strain impulses are summed onto the cluster body, and released if greater than the encoded strain.
Public function void BreakingModel Implements the promotion breaking model, where strain impulses are summed onto the cluster body, and released if greater than the encoded strain.
Public function void CleanupInternalClustersForProxies For a given set of physics proxies, cleanup any tracked internal clusters that we've marked as being empty.
Public function void  
Protected function void

ComputeStrainFromCollision ( const FPBDCollisionConstraints& CollisionRule,
const FReal Dt
)

  
Public function Chaos::FPBDRigidClusteredParticleHandle *

CreateClusterParticle ( const int32 ClusterGroupIndex,
TArray< Chaos::FPBDRigidParticleHandle* >&& Children,
const FClusterCreationParameters& Parameters,
TSharedPtr< Chaos::FImplicitObject, ESPMode::ThreadSafe > ProxyGeometry,
const FRigidTransform3* ForceMassOrientation,
const FUniqueIdx* ExistingIndex
)

 Initialization Initialize a cluster with the specified children.
Public function Chaos::FPBDRigidClusteredParticleHandle * CreateClusterParticleFromClusterChildren Children : Rigid body ID to include in the cluster.
Protected function TArray< FPBDRigidParticleHandle * >  
Public function void

CreateNodeConnection ( ParticleHandleTypeA* A,
ParticleHandleTypeB* B
)

  
Public function void  
Public function TSet< FPBDRigidParticleHandle * > Releasing DeactivateClusterParticle Release all the particles within the cluster particle
Public function FPBDRigidClusteredParticleHandle * DestroyClusterParticle Disable the cluster particle and remove from all internal clustering structures.
Protected function void  
Public function Const TArray< FPBDRigidParticleHandle * >

FindChildrenWithinRadius ( const FPBDRigidClusteredParticleHandle* ClusteredParticle,
const FVec3& WorldLocation,
FReal Radius,
bool bAlwaysReturnClosest
)

 FindChildrenWithinRadius Find the children of an active cluster from a world position and a radius current implementation will pick the closest based on the distance from the center future implementation may expose option for more precise queries if bAlwaysReturnClosest is checked this will always return the closest from the location even if the radius does not encompass any center of mass
Public function Const FPBDRigidParticleHandle *

FindClosestChild ( const FPBDRigidClusteredParticleHandle* ClusteredParticle,
const FVec3& WorldLocation
)

 FindClosestChild Find the closest child of an active cluster from a world position current implementation will pick the closest based on the distance from the center future implementation may expose option for more precise queries
Public function Static FPBDRigidParticleHandle *

FindClosestParticle ( const TArray< FPBDRigidParticleHandle* >& Particles,
const FVec3& WorldLocation
)

 FindClosest Find the closest particle from an array of particle current implementation will pick the closest based on the distance from the center future implementation may expose option for more precise queries
Protected function TArray< FParticleIsland >

FindIslandsInChildren ( const FPBDRigidClusteredParticleHandle* ClusteredParticle,
bool bTraverseInterclusterEdges
)

  
Public function Static TArray< FPBDRigidParticleHandle * >

FindParticlesWithinRadius ( const TArray< FPBDRigidParticleHandle* >& Particles,
const FVec3& WorldLocation,
FReal Radius,
bool bAlwaysReturnClosest
)

 FindParticlesWithinRadius Find the closest particle from an array of particle from a world position and a radius current implementation will pick the closest based on the distance from the center future implementation may expose option for more precise queries if bAlwaysReturnClosest is checked this will always return the closest from the location even if the radius does not encompass any center of mass
Protected function void  
Protected function void  
Public function void

ForceReleaseChildParticleAndParents ( FPBDRigidClusteredParticleHandle* ChildClusteredParticle,
bool bTriggerBreakEvents
)

 Force Release a particle at any level by making sure their parent particles are also release if necessary this will force all particles including the ones in the parent chain to be made breakable
Public function void

GenerateConnectionGraph ( TArray< FPBDRigidParticleHandle* > Particles,
const FClusterCreationParameters& Parameters,
const TSet< FPBDRigidParticleHandle* >* FromParticles,
const TSet< FPBDRigidParticleHandle* >* ToParticles
)

  
Public function void  
Public function FPBDRigidParticleHandle * GetActiveClusterIndex Get the current childs active cluster.
Public function Const const TArray< FBreakingData > & Cluster Break Data The cluster breaks can be used to seed particle emissions.
Public function Const const TArray< FCrumblingData > & Cluster crumbling Data triggered when all the children of a cluster are released all at once event is generated only if the owning proxy allows it
Public function Const const FClusterMap &  
Public function FClusterMap & GetParentToChildren The parent to children map stores the currently active cluster ids (Particle Indices) as the keys of the map.
Public function Const const TArrayCollectionArray< FRigidTransform3 > & GetChildToParentMap This map stores the relative transform from a child to its cluster parent.
Public function TArrayCollectionArray< int32 > & GetClusterGroupIndexArray The group index is used to automatically bind disjoint clusters.
Public function Const const TArrayCollectionArray< ClusterId > &  
Public function TArrayCollectionArray< ClusterId > & GetClusterIdsArray The cluster ids provide a mapping from the rigid body index to its parent cluster id.
Public function Const FClusterCreationParameters::EConnectionMethod  
Public function Const const FClusterUnionManager &  
Public function FClusterUnionManager &  
Public function Const const TArrayCollectionArray< TArray< TConnectivityEdge< FReal > > > & GetConnectivityEdges Provides a list of each rigid body's current siblings and associated strain within the cluster.
Public function Const bool  
Public function FRigidEvolution &  
Public function Const const FRigidEvolution &  
Public function Const const TArrayCollectionArray< FRigidClusteredFlags > & GetRigidClusteredFlagsArray The RigidClusteredFlags array contains various flag related to clustered particles
Public function Const const TArrayCollectionArray< FRealSingle > &  
Public function TArrayCollectionArray< FRealSingle > & GetStrainArray The strain array is used to store the maximum strain allowed for a individual body in the simulation.
Public function TSet< Chaos::FPBDRigidClusteredParticleHandle * > &  
Public function Const const TSet< Chaos::FPBDRigidClusteredParticleHandle * > &  
Public function Const const TSet< Chaos::FPBDRigidClusteredParticleHandle * > &  
Protected function TSet< FPBDRigidParticleHandle * >

HandleConnectivityOnReleaseClusterParticle ( FPBDRigidClusteredParticleHandle* ClusteredParticle,
bool bCreateNewClusters
)

 Handles leveraging the connectivity edges on the children of the clustered particle to produce the desired effects.
Public function TSet< FPBDRigidParticleHandle * >

ReleaseClusterParticles ( FPBDRigidClusteredParticleHandle* ClusteredParticle,
bool bForceRelease
)

 ReleaseClusterParticles (BasedOnStrain) Release clusters based on the passed in ExternalStrainArray_, or the particle handle's current CollisionImpulses()_ value.
Public function TSet< FPBDRigidParticleHandle * >

ReleaseClusterParticles ( TArray< FPBDRigidParticleHandle* > ChildrenParticles,
bool bTriggerBreakEvents
)

 ReleaseClusterParticles Release all rigid body IDs passed,
Protected function TSet< FPBDRigidParticleHandle * >

ReleaseClusterParticlesImpl ( FPBDRigidClusteredParticleHandle* ClusteredParticle,
bool bForceRelease,
bool bCreateNewClusters
)

  
Public function TSet< FPBDRigidParticleHandle * >  
Protected function void  
Protected function void  
Public function void Remove connectivity edges for specified particles.
Public function void Remove connectivity edges for specified particles.
Public function void Manually remove a set of particles from the cluster.
Public function void  
Public function void  
Public function void Reset all events ( this include breaking, crumbling event and tracking data
Protected function void  
Protected function void Restore some percentage of momenta for objects which were involved in collisions with destroyed GCs
Protected function void

SendBreakingEvent ( FPBDRigidClusteredParticleHandle* ClusteredParticle,
bool bFromCrumble
)

  
Protected function void  
Public function void

SetClusterConnectionFactor ( FReal ClusterConnectionFactorIn
)

 GenerateConnectionGraph Creates a connection graph for the given index using the creation parameters.
Public function void  
Public function void  
Public function void

SetGenerateClusterBreaking ( bool DoGenerate
)

  
Public function void  
Public function Static bool  
Protected function void When a body has broken due to contact resolution, record an entry in a set for the collision and the particle who's momentum should be restored.
Public function void UnionClusterGroups Clusters that share a group index should be unioned into a single cluster prior to simulation.
Protected function void This function is a bit more versatile than the name suggests.
Protected function void  
Protected function void  
Protected function void  
Protected function void  
Protected function void

UpdateConnectivityGraphUsingPointImplicit ( const TArray< FPBDRigidParticleHandle* >& Particles,
FReal CollisionThicknessPercent,
const TSet< FPBDRigidParticleHandle* >* FromParticles,
const TSet< FPBDRigidParticleHandle* >* ToParticles
)

 Connectivity
Protected function void  
Protected function void  
Public function void

Visitor ( FClusterHandle Cluster,
FVisitorFunction Function
)

 Access

Typedefs

Name Description
FClusterHandle  
FClusterMap  
FParticleIsland  
FRigidEvolution  
FRigidHandle  
FRigidHandleArray  
FVisitorFunction  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page