ezEngine  Milestone 7
ezTimeStepSmoothing Class Referenceabstract

Base class for all time step smoothing algorithms. More...

#include <Clock.h>

Inheritance diagram for ezTimeStepSmoothing:

Public Member Functions

virtual ezTime GetSmoothedTimeStep (ezTime RawTimeStep, const ezClock *pClock)=0
 The function to override to implement time step smoothing. More...
 
virtual void Reset (const ezClock *pClock)=0
 Called when ezClock::Reset(), ezClock::Load() or ezClock::SetPaused(true) was called. More...
 

Detailed Description

Base class for all time step smoothing algorithms.

By deriving from this class you can implement your own algorithms for time step smoothing. Then just set an instance of that class on one of the clocks and it will be applied to the time step.

Member Function Documentation

virtual ezTime ezTimeStepSmoothing::GetSmoothedTimeStep ( ezTime  RawTimeStep,
const ezClock pClock 
)
pure virtual

The function to override to implement time step smoothing.

Parameters
RawTimeStepThe actual raw time difference since the last clock update without any modification.
pClockThe clock that calls this time step smoother. Can be used to look up the clock speed and min/max time step.
Note
It is the responsibility of each ezTimeStepSmoothing class to implement clock speed and also to clamp the time step to the min/max values. This allows the smoothing algorithm to override these values, if necessary.

Implemented in ezDefaultTimeStepSmoothing.

virtual void ezTimeStepSmoothing::Reset ( const ezClock pClock)
pure virtual

Called when ezClock::Reset(), ezClock::Load() or ezClock::SetPaused(true) was called.

Parameters
pClockThe clock that is calling this function.

Implemented in ezDefaultTimeStepSmoothing.


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