UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Public Member Functions | Protected Attributes | List of all members
IChaosEventFilter< SourceType, DestinationType, SortMethodType > Class Template Referenceabstract

#include <ChaosFilter.h>

Public Member Functions

virtual ~IChaosEventFilter ()
 
virtual void FilterEvents (const FTransform &ChaosComponentTransform, const SourceType &RawInputDataArray)=0
 
virtual void FilterEvents (const SourceType &RawInputDataArray)
 
virtual void SortEvents (DestinationType &InOutFilteredEvents, SortMethodType SortMethod, const FTransform &InTransform)=0
 
const DestinationType & GetFilteredResults () const
 
int32 GetNumEvents () const
 
void SetTransform (const FTransform &TransformIn)
 

Protected Attributes

DestinationType FilteredDataArray
 
FTransform Transform
 

Detailed Description

template<class SourceType, class DestinationType, class SortMethodType>
class IChaosEventFilter< SourceType, DestinationType, SortMethodType >

TChaosEventFilter (template for Chaos Event Filters)

Constructor & Destructor Documentation

◆ ~IChaosEventFilter()

template<class SourceType , class DestinationType , class SortMethodType >
virtual IChaosEventFilter< SourceType, DestinationType, SortMethodType >::~IChaosEventFilter ( )
inlinevirtual

Member Function Documentation

◆ FilterEvents() [1/2]

template<class SourceType , class DestinationType , class SortMethodType >
virtual void IChaosEventFilter< SourceType, DestinationType, SortMethodType >::FilterEvents ( const FTransform &  ChaosComponentTransform,
const SourceType &  RawInputDataArray 
)
pure virtual

Filters the raw events from the physics system to reduce the number supplied to the game systems

Implemented in FChaosBreakingEventFilter, FChaosCollisionEventFilter, FChaosRemovalEventFilter, and FChaosTrailingEventFilter.

◆ FilterEvents() [2/2]

template<class SourceType , class DestinationType , class SortMethodType >
virtual void IChaosEventFilter< SourceType, DestinationType, SortMethodType >::FilterEvents ( const SourceType &  RawInputDataArray)
inlinevirtual

Filters the raw events from the physics system to reduce the number supplied to the game systems

◆ GetFilteredResults()

template<class SourceType , class DestinationType , class SortMethodType >
const DestinationType & IChaosEventFilter< SourceType, DestinationType, SortMethodType >::GetFilteredResults ( ) const
inline

Gain access to the filtered results

◆ GetNumEvents()

template<class SourceType , class DestinationType , class SortMethodType >
int32 IChaosEventFilter< SourceType, DestinationType, SortMethodType >::GetNumEvents ( ) const
inline

Get the number of filtered results

◆ SetTransform()

template<class SourceType , class DestinationType , class SortMethodType >
void IChaosEventFilter< SourceType, DestinationType, SortMethodType >::SetTransform ( const FTransform &  TransformIn)
inline

◆ SortEvents()

template<class SourceType , class DestinationType , class SortMethodType >
virtual void IChaosEventFilter< SourceType, DestinationType, SortMethodType >::SortEvents ( DestinationType &  InOutFilteredEvents,
SortMethodType  SortMethod,
const FTransform &  InTransform 
)
pure virtual

Optionally Sort events based on increasing or decreasing values of FilteredDataArray fields

Implemented in FChaosBreakingEventFilter, FChaosCollisionEventFilter, FChaosRemovalEventFilter, and FChaosTrailingEventFilter.

Member Data Documentation

◆ FilteredDataArray

template<class SourceType , class DestinationType , class SortMethodType >
DestinationType IChaosEventFilter< SourceType, DestinationType, SortMethodType >::FilteredDataArray
protected

The filtered results (a subset of the full raw events buffer)

◆ Transform

template<class SourceType , class DestinationType , class SortMethodType >
FTransform IChaosEventFilter< SourceType, DestinationType, SortMethodType >::Transform
protected

Filter results relative to a transform location

The documentation for this class was generated from the following file: