UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FExternalSpatialAccelerationPayload Struct Reference

#include <ExternalSpatialAccelerationPayload.h>

Public Member Functions

ENGINE_API FExternalSpatialAccelerationPayload ()
 
ENGINE_API void Initialize (TObjectKey< UPrimitiveComponent > InComponent, int32 InBoneId)
 
ENGINE_API void Initialize (TObjectKey< UPrimitiveComponent > InComponent, int32 InBoneId, const Chaos::FUniqueIdx &UniqueIdx)
 
ENGINE_API Chaos::FGeometryParticleGetExternalGeometryParticle_ExternalThread () const
 
bool operator== (const FExternalSpatialAccelerationPayload &Other) const
 
bool operator!= (const FExternalSpatialAccelerationPayload &Other) const
 
ENGINE_API Chaos::FUniqueIdx UniqueIdx () const
 
ENGINE_API void Serialize (Chaos::FChaosArchive &Ar)
 
bool PrePreQueryFilter (const void *QueryData) const
 
bool PrePreSimFilter (const void *SimData) const
 
bool IsValid () const
 

Static Public Attributes

static constexpr bool bHasPayloadOnInternalThread = false
 

Friends

ENGINE_API uint32 GetTypeHash (const FExternalSpatialAccelerationPayload &Payload)
 

Detailed Description

This is a Chaos spatial acceleration payload that can be used for spatial acceleration structures that are meant to only be used in external contexts. This provides safety as we aren't holding particle handles directly but rather going through the primitive component's physics object interface to grab them when needed.

Constructor & Destructor Documentation

◆ FExternalSpatialAccelerationPayload()

FExternalSpatialAccelerationPayload::FExternalSpatialAccelerationPayload ( )

Member Function Documentation

◆ GetExternalGeometryParticle_ExternalThread()

Chaos::FGeometryParticle * FExternalSpatialAccelerationPayload::GetExternalGeometryParticle_ExternalThread ( ) const

◆ Initialize() [1/2]

void FExternalSpatialAccelerationPayload::Initialize ( TObjectKey< UPrimitiveComponent >  InComponent,
int32  InBoneId 
)

◆ Initialize() [2/2]

void FExternalSpatialAccelerationPayload::Initialize ( TObjectKey< UPrimitiveComponent >  InComponent,
int32  InBoneId,
const Chaos::FUniqueIdx UniqueIdx 
)

◆ IsValid()

bool FExternalSpatialAccelerationPayload::IsValid ( ) const
inline

◆ operator!=()

bool FExternalSpatialAccelerationPayload::operator!= ( const FExternalSpatialAccelerationPayload Other) const
inline

◆ operator==()

bool FExternalSpatialAccelerationPayload::operator== ( const FExternalSpatialAccelerationPayload Other) const
inline

◆ PrePreQueryFilter()

bool FExternalSpatialAccelerationPayload::PrePreQueryFilter ( const void QueryData) const
inline

◆ PrePreSimFilter()

bool FExternalSpatialAccelerationPayload::PrePreSimFilter ( const void SimData) const
inline

◆ Serialize()

void FExternalSpatialAccelerationPayload::Serialize ( Chaos::FChaosArchive Ar)

◆ UniqueIdx()

Chaos::FUniqueIdx FExternalSpatialAccelerationPayload::UniqueIdx ( ) const

Friends And Related Symbol Documentation

◆ GetTypeHash

ENGINE_API uint32 GetTypeHash ( const FExternalSpatialAccelerationPayload Payload)
friend

Member Data Documentation

◆ bHasPayloadOnInternalThread

constexpr bool FExternalSpatialAccelerationPayload::bHasPayloadOnInternalThread = false
staticconstexpr

The documentation for this struct was generated from the following files: