xiiTimeStepSmoothing Class Reference

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

#include <Clock.h>

Inheritance diagram for xiiTimeStepSmoothing:

Public Member Functions
virtual xiiTime	GetSmoothedTimeStep (xiiTime rawTimeStep, const xiiClock *pClock)=0
	The function to override to implement time step smoothing.
virtual void	Reset (const xiiClock *pClock)=0
	Called when xiiClock::Reset(), xiiClock::Load() or xiiClock::SetPaused(true) was called.

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

GetSmoothedTimeStep()

virtual xiiTime xiiTimeStepSmoothing::GetSmoothedTimeStep ( xiiTime rawTimeStep, const xiiClock * pClock )

pure virtual

The function to override to implement time step smoothing.

Parameters

RawTimeStep	The actual raw time difference since the last clock update without any modification.
pClock	The 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 xiiTimeStepSmoothing 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 xiiDefaultTimeStepSmoothing.

Reset()

virtual void xiiTimeStepSmoothing::Reset ( const xiiClock * pClock )

pure virtual

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

Parameters

pClock

The clock that is calling this function.

Implemented in xiiDefaultTimeStepSmoothing.

---

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

• /home/runner/work/XII/XII/Source/Engine/Foundation/Time/Clock.h