UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Classes | Public Types | Public Member Functions | Friends | List of all members
Chaos::Private::FCollisionParticlePairKey Class Reference

#include <CollisionKeys.h>

Public Types

using KeyType = uint64
 

Public Member Functions

 FCollisionParticlePairKey ()
 
 FCollisionParticlePairKey (const FGeometryParticleHandle *Particle0, const FGeometryParticleHandle *Particle1, const bool bSymmetric=true)
 
uint64 GetKey () const
 
uint32 GetHash () const
 

Friends

bool operator== (const FCollisionParticlePairKey &L, const FCollisionParticlePairKey &R)
 
bool operator!= (const FCollisionParticlePairKey &L, const FCollisionParticlePairKey &R)
 
bool operator< (const FCollisionParticlePairKey &L, const FCollisionParticlePairKey &R)
 

Detailed Description

A key which uniquely identifes a particle pair for use by the collision detection system. This key can optionally be the same if particles order is reversed (see bSymmetric constructor parameter).

Note
This uses ParticleID and truncates it to 31 bits (from 32)

Member Typedef Documentation

◆ KeyType

using Chaos::Private::FCollisionParticlePairKey::KeyType = uint64

Constructor & Destructor Documentation

◆ FCollisionParticlePairKey() [1/2]

Chaos::Private::FCollisionParticlePairKey::FCollisionParticlePairKey ( )
inline

◆ FCollisionParticlePairKey() [2/2]

Chaos::Private::FCollisionParticlePairKey::FCollisionParticlePairKey ( const FGeometryParticleHandle *  Particle0,
const FGeometryParticleHandle *  Particle1,
const bool  bSymmetric = true 
)
inline

Member Function Documentation

◆ GetHash()

uint32 Chaos::Private::FCollisionParticlePairKey::GetHash ( ) const
inline

◆ GetKey()

uint64 Chaos::Private::FCollisionParticlePairKey::GetKey ( ) const
inline

Friends And Related Symbol Documentation

◆ operator!=

bool operator!= ( const FCollisionParticlePairKey &  L,
const FCollisionParticlePairKey &  R 
)
friend

◆ operator<

bool operator< ( const FCollisionParticlePairKey &  L,
const FCollisionParticlePairKey &  R 
)
friend

◆ operator==

bool operator== ( const FCollisionParticlePairKey &  L,
const FCollisionParticlePairKey &  R 
)
friend
The documentation for this class was generated from the following file: