UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
Chaos::FEventContainerBase Class Referenceabstract

#include <EventManager.h>

+ Inheritance diagram for Chaos::FEventContainerBase:

Public Member Functions

virtual ~FEventContainerBase ()
 
virtual void RegisterHandler (const FEventHandlerPtr &Handler)=0
 
virtual void UnregisterHandler (const void *Handler)=0
 
virtual void InjectProducerData (const FPBDRigidsSolver *Solver, bool bResetData)=0
 
virtual void FlipBufferIfRequired ()=0
 
virtual void ResetConsumerBuffer ()=0
 
virtual void DispatchConsumerData ()=0
 

Detailed Description

Interface for the injected producer function and associated data buffer

Constructor & Destructor Documentation

◆ ~FEventContainerBase()

virtual Chaos::FEventContainerBase::~FEventContainerBase ( )
inlinevirtual

Member Function Documentation

◆ DispatchConsumerData()

virtual void Chaos::FEventContainerBase::DispatchConsumerData ( )
pure virtual

Dispatch events to the registered handlers

Implemented in Chaos::TEventContainer< PayloadType >.

◆ FlipBufferIfRequired()

virtual void Chaos::FEventContainerBase::FlipBufferIfRequired ( )
pure virtual

Flips the buffer if the buffer type is double or triple

Implemented in Chaos::TEventContainer< PayloadType >.

◆ InjectProducerData()

virtual void Chaos::FEventContainerBase::InjectProducerData ( const FPBDRigidsSolver Solver,
bool  bResetData 
)
pure virtual

◆ RegisterHandler()

virtual void Chaos::FEventContainerBase::RegisterHandler ( const FEventHandlerPtr Handler)
pure virtual

Register the delegate function that will handle the events on the game thread

Implemented in Chaos::TEventContainer< PayloadType >.

◆ ResetConsumerBuffer()

virtual void Chaos::FEventContainerBase::ResetConsumerBuffer ( )
pure virtual

Reset the consumer buffer, can be used just before flipping buffers to start with a clean buffer

Implemented in Chaos::TEventContainer< PayloadType >.

◆ UnregisterHandler()

virtual void Chaos::FEventContainerBase::UnregisterHandler ( const void Handler)
pure virtual

Unregister the delegate function that handles the events on the game thread

Implemented in Chaos::TEventContainer< PayloadType >.


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