Chaos::ITimeStep Class Reference

#include <TimeStep.h>

Public Member Functions
virtual	~ITimeStep ()
virtual void	Reset ()
virtual void	Update ()=0
virtual float	GetCalculatedDt () const =0
virtual float	GetActualDt () const
virtual void	SetTarget (float InTarget)
virtual float	GetTarget () const

Constructor & Destructor Documentation

~ITimeStep()

virtual Chaos::ITimeStep::~ITimeStep ( )

inlinevirtual

Member Function Documentation

GetActualDt()

virtual float Chaos::ITimeStep::GetActualDt ( ) const

inlinevirtual

Get how much time actually passed (Dt and any sleeps) mainly for stats. By default will just return Dt

GetCalculatedDt()

virtual float Chaos::ITimeStep::GetCalculatedDt ( ) const

pure virtual

Get the next dt to use in simulation

GetTarget()

virtual float Chaos::ITimeStep::GetTarget ( ) const

inlinevirtual

Called to retrieve the target time for the timestep. By default returns whatever the Dt was intended to be

Reset()

virtual void Chaos::ITimeStep::Reset ( )

inlinevirtual

Reset the timestep to a default state. Called on restarting a simulation. Note we will not update till after an evolution so GetDt must succeed beore we call the first Update

SetTarget()

virtual void Chaos::ITimeStep::SetTarget ( float  InTarget )

inlinevirtual

Called to set a target dt if necessary - derived timesteps can ignore if not needed

Update()

virtual void Chaos::ITimeStep::Update ( )

pure virtual

Perform any necessary update to calculate the next timestep, if any sleeps for synchronisation are required also perform them here

---

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

• Engine/Source/Runtime/Experimental/Chaos/Public/Framework/TimeStep.h