UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
PhysicsFiltering.h File Reference

Go to the source code of this file.

Classes

struct  FPhysicsFilterBuilder
 

Enumerations

enum  EPhysXFilterDataFlags {
  EPDF_SimpleCollision = 0x0001 , EPDF_ComplexCollision = 0x0002 , EPDF_CCD = 0x0004 , EPDF_ContactNotify = 0x0008 ,
  EPDF_StaticShape = 0x0010 , EPDF_ModifyContacts = 0x0020 , EPDF_KinematicKinematicPairs = 0x0040
}
 
enum  { NumCollisionChannelBits = 5 }
 
enum  { NumFilterDataFlagBits = 32 - NumExtraFilterBits - NumCollisionChannelBits }
 

Functions

void CreateShapeFilterData (const uint8 MyChannel, const FMaskFilter MaskFilter, const int32 SourceObjectID, const FCollisionResponseContainer &ResponseToChannels, uint32 ComponentID, uint16 BodyIndex, FCollisionFilterData &OutQueryData, FCollisionFilterData &OutSimData, bool bEnableCCD, bool bEnableContactNotify, bool bStaticShape, bool bModifyContacts=false)
 
ECollisionChannel GetCollisionChannel (uint32 Word3)
 
ECollisionChannel GetCollisionChannelAndExtraFilter (uint32 Word3, FMaskFilter &OutMaskFilter)
 
uint32 CreateChannelAndFilter (ECollisionChannel CollisionChannel, FMaskFilter MaskFilter)
 
void UpdateMaskFilter (uint32 &Word3, FMaskFilter NewMaskFilter)
 
FCollisionResponseContainer ExtractSimCollisionResponseContainer (const FCollisionFilterData &InSimFilterData)
 
FCollisionResponseContainer ExtractQueryCollisionResponseContainer (const FCollisionFilterData &InQueryFilterData)
 

Enumeration Type Documentation

◆ anonymous enum

Enumerator
NumCollisionChannelBits 

◆ anonymous enum

Enumerator
NumFilterDataFlagBits 

◆ EPhysXFilterDataFlags

Set of flags stored in the PhysX FilterData

When this flag is saved in CreateShapeFilterData or CreateQueryFilterData, we only use 23 bits If you plan to use more than 23 bits, you'll also need to change the format of ShapeFilterData,QueryFilterData Make sure you also change preFilter/SimFilterShader where it's used

Enumerator
EPDF_SimpleCollision 
EPDF_ComplexCollision 
EPDF_CCD 
EPDF_ContactNotify 
EPDF_StaticShape 
EPDF_ModifyContacts 
EPDF_KinematicKinematicPairs 

Function Documentation

◆ CreateChannelAndFilter()

uint32 CreateChannelAndFilter ( ECollisionChannel  CollisionChannel,
FMaskFilter  MaskFilter 
)
inline

◆ CreateShapeFilterData()

void CreateShapeFilterData ( const uint8  MyChannel,
const FMaskFilter  MaskFilter,
const int32  SourceObjectID,
const FCollisionResponseContainer ResponseToChannels,
uint32  ComponentID,
uint16  BodyIndex,
FCollisionFilterData OutQueryData,
FCollisionFilterData OutSimData,
bool  bEnableCCD,
bool  bEnableContactNotify,
bool  bStaticShape,
bool  bModifyContacts = false 
)
inline

Utility for creating a FCollisionFilterData for filtering query (trace) and sim (physics) from the Unreal filtering info.

◆ ExtractQueryCollisionResponseContainer()

FCollisionResponseContainer ExtractQueryCollisionResponseContainer ( const FCollisionFilterData InQueryFilterData)
inline

◆ ExtractSimCollisionResponseContainer()

FCollisionResponseContainer ExtractSimCollisionResponseContainer ( const FCollisionFilterData InSimFilterData)
inline

◆ GetCollisionChannel()

ECollisionChannel GetCollisionChannel ( uint32  Word3)
inline

◆ GetCollisionChannelAndExtraFilter()

ECollisionChannel GetCollisionChannelAndExtraFilter ( uint32  Word3,
FMaskFilter OutMaskFilter 
)
inline

◆ UpdateMaskFilter()

void UpdateMaskFilter ( uint32 Word3,
FMaskFilter  NewMaskFilter 
)
inline