Chaos::FPhysicsSolverEvents Class Reference

#include <PhysicsSolverBase.h>

Inheritance diagram for Chaos::FPhysicsSolverEvents:

Public Member Functions
virtual	~FPhysicsSolverEvents ()
CHAOS_API FDelegateHandle	AddPreAdvanceCallback (FSolverPreAdvance::FDelegate InDelegate)
CHAOS_API bool	RemovePreAdvanceCallback (FDelegateHandle InHandle)
CHAOS_API FDelegateHandle	AddPreBufferCallback (FSolverPreAdvance::FDelegate InDelegate)
CHAOS_API bool	RemovePreBufferCallback (FDelegateHandle InHandle)
CHAOS_API FDelegateHandle	AddPostAdvanceCallback (FSolverPostAdvance::FDelegate InDelegate)
CHAOS_API bool	RemovePostAdvanceCallback (FDelegateHandle InHandle)
CHAOS_API FDelegateHandle	AddTeardownCallback (FSolverTeardown::FDelegate InDelegate)
CHAOS_API bool	RemoveTeardownCallback (FDelegateHandle InHandle)
void	ClearCallbacks ()

Protected Attributes
FSolverPreAdvance	EventPreSolve
FSolverPreBuffer	EventPreBuffer
FSolverPostAdvance	EventPostSolve
FSolverTeardown	EventTeardown

Detailed Description

Base solver class storing events that will be used by the derived solver during the solve. Currently used by caching but could be used for any other pre/post solve works that need to be done.

Constructor & Destructor Documentation

~FPhysicsSolverEvents()

virtual Chaos::FPhysicsSolverEvents::~FPhysicsSolverEvents ( )

inlinevirtual

Only allow construction with valid parameters as well as restricting to module construction

Member Function Documentation

AddPostAdvanceCallback()

FDelegateHandle Chaos::FPhysicsSolverEvents::AddPostAdvanceCallback

(

FSolverPostAdvance::FDelegate

InDelegate

)

Post advance happens after all processing and results generation has been completed

AddPreAdvanceCallback()

FDelegateHandle Chaos::FPhysicsSolverEvents::AddPreAdvanceCallback

(

FSolverPreAdvance::FDelegate

InDelegate

)

Events WARNING: Events are not threadsafe! Pre advance is called before any physics processing or simulation happens in a given physics update

AddPreBufferCallback()

FDelegateHandle Chaos::FPhysicsSolverEvents::AddPreBufferCallback

(

FSolverPreAdvance::FDelegate

InDelegate

)

Pre buffer happens after the simulation has been advanced (particle positions etc. will have been updated) but GT results haven't been prepared yet

AddTeardownCallback()

FDelegateHandle Chaos::FPhysicsSolverEvents::AddTeardownCallback

(

FSolverTeardown::FDelegate

InDelegate

)

Teardown happens as the solver is destroyed or streamed out

ClearCallbacks()

void Chaos::FPhysicsSolverEvents::ClearCallbacks ( )

inline

Clear all the callbacks

RemovePostAdvanceCallback()

bool Chaos::FPhysicsSolverEvents::RemovePostAdvanceCallback

(

FDelegateHandle

InHandle

)

RemovePreAdvanceCallback()

bool Chaos::FPhysicsSolverEvents::RemovePreAdvanceCallback

(

FDelegateHandle

InHandle

)

RemovePreBufferCallback()

bool Chaos::FPhysicsSolverEvents::RemovePreBufferCallback

(

FDelegateHandle

InHandle

)

RemoveTeardownCallback()

bool Chaos::FPhysicsSolverEvents::RemoveTeardownCallback

(

FDelegateHandle

InHandle

)

Member Data Documentation

EventPostSolve

FSolverPostAdvance Chaos::FPhysicsSolverEvents::EventPostSolve

protected

EventPreBuffer

FSolverPreBuffer Chaos::FPhysicsSolverEvents::EventPreBuffer

protected

EventPreSolve

FSolverPreAdvance Chaos::FPhysicsSolverEvents::EventPreSolve

protected

Storage for events, see the Add/Remove pairs above for event timings

EventTeardown

FSolverTeardown Chaos::FPhysicsSolverEvents::EventTeardown

protected

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Chaos/Framework/PhysicsSolverBase.h
• Engine/Source/Runtime/Experimental/Chaos/Private/Chaos/Framework/PhysicsSolverBase.cpp