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

#include <ParticleHandle.h>

Public Member Functions

 FGenericParticleHandle ()
 
 FGenericParticleHandle (FGeometryParticleHandle *InHandle)
 
FGenericParticleHandleImp * operator-> () const
 
FGenericParticleHandleImp * Get () const
 
bool IsValid () const
 

Friends

uint32 GetTypeHash (const FGenericParticleHandle &H)
 
bool operator== (const FGenericParticleHandle &L, const FGenericParticleHandle &R)
 
bool operator!= (const FGenericParticleHandle &L, const FGenericParticleHandle &R)
 
bool operator< (const FGenericParticleHandle &L, const FGenericParticleHandle &R)
 

Detailed Description

A wrapper around any type of particle handle to provide a consistent (read-only) API for all particle types. This can make code simpler because you can write code that is type-agnostic, but it has a cost. Where possible it is better to write code that is specific to the type(s) of particles being operated on. FGenericParticleHandle has pointer semantics, so you can use one wherever you have a particle handle pointer;

Constructor & Destructor Documentation

◆ FGenericParticleHandle() [1/2]

Chaos::FGenericParticleHandle::FGenericParticleHandle ( )
inline

◆ FGenericParticleHandle() [2/2]

Chaos::FGenericParticleHandle::FGenericParticleHandle ( FGeometryParticleHandle *  InHandle)
inline

Member Function Documentation

◆ Get()

FGenericParticleHandleImp * Chaos::FGenericParticleHandle::Get ( ) const
inline

◆ IsValid()

bool Chaos::FGenericParticleHandle::IsValid ( ) const
inline

◆ operator->()

FGenericParticleHandleImp * Chaos::FGenericParticleHandle::operator-> ( ) const
inline

Friends And Related Symbol Documentation

◆ GetTypeHash

uint32 GetTypeHash ( const FGenericParticleHandle &  H)
friend

◆ operator!=

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

◆ operator<

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

◆ operator==

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