Cogs::Interpolator< T > Class Template Reference

#include <Interpolator.h>

Public Member Functions
	Interpolator (T &destination)
	Interpolator (T &destination, const T &target, EasingFn::Ptr fn, float duration)
void	setTarget (const T &target, EasingFn::Ptr fn, float duration)
void	snapToTarget ()
bool	process ()
void	cancel ()
bool	isProcessing () const
float	getTime ()
T	getTarget () const
T	getValue () const

Private Attributes
T &	mDestination
T	mStart
T	mTarget
Timer	mTimer
EasingFn::Ptr	mFunction = nullptr
float	mDuration = 0.0f

Constructor & Destructor Documentation

Interpolator() [1/2]

template<typename T >

Cogs::Interpolator< T >::Interpolator ( T &  destination )

inline

Interpolator() [2/2]

template<typename T >

Cogs::Interpolator< T >::Interpolator ( T &  destination, const T &  target, EasingFn::Ptr  fn, float  duration  )

inline

References Cogs::Interpolator< T >::setTarget().

Member Function Documentation

cancel()

template<typename T >

void Cogs::Interpolator< T >::cancel ( )

inline

References Cogs::Interpolator< T >::mFunction.

getTarget()

template<typename T >

T Cogs::Interpolator< T >::getTarget ( ) const

inline

References Cogs::Interpolator< T >::mTarget.

getTime()

template<typename T >

float Cogs::Interpolator< T >::getTime ( )

inline

References Cogs::Timer::elapsedSeconds(), Cogs::Interpolator< T >::isProcessing(), and Cogs::Interpolator< T >::mTimer.

getValue()

template<typename T >

T Cogs::Interpolator< T >::getValue ( ) const

inline

References Cogs::Interpolator< T >::mDestination.

isProcessing()

template<typename T >

bool Cogs::Interpolator< T >::isProcessing ( ) const

inline

References Cogs::Interpolator< T >::mFunction.

Referenced by Cogs::Interpolator< T >::getTime().

process()

template<typename T >

bool Cogs::Interpolator< T >::process ( )

inline

References Cogs::Timer::elapsedSeconds(), Cogs::interpolateFn(), Cogs::Interpolator< T >::mDestination, Cogs::Interpolator< T >::mDuration, Cogs::Interpolator< T >::mFunction, Cogs::Interpolator< T >::mStart, Cogs::Interpolator< T >::mTarget, and Cogs::Interpolator< T >::mTimer.

setTarget()

template<typename T >

void Cogs::Interpolator< T >::setTarget ( const T &  target, EasingFn::Ptr  fn, float  duration  )

inline

References Cogs::Interpolator< T >::mDestination, Cogs::Interpolator< T >::mDuration, Cogs::Interpolator< T >::mFunction, Cogs::Interpolator< T >::mStart, Cogs::Interpolator< T >::mTarget, Cogs::Interpolator< T >::mTimer, and Cogs::Timer::start().

Referenced by Cogs::Interpolator< T >::Interpolator().

snapToTarget()

template<typename T >

void Cogs::Interpolator< T >::snapToTarget ( )

inline

References Cogs::Interpolator< T >::mDestination, Cogs::Interpolator< T >::mFunction, and Cogs::Interpolator< T >::mTarget.

Member Data Documentation

mDestination

template<typename T >

T& Cogs::Interpolator< T >::mDestination

private

Referenced by Cogs::Interpolator< T >::getValue(), Cogs::Interpolator< T >::process(), Cogs::Interpolator< T >::setTarget(), and Cogs::Interpolator< T >::snapToTarget().

mDuration

template<typename T >

float Cogs::Interpolator< T >::mDuration = 0.0f

private

Referenced by Cogs::Interpolator< T >::process(), and Cogs::Interpolator< T >::setTarget().

mFunction

template<typename T >

EasingFn::Ptr Cogs::Interpolator< T >::mFunction = nullptr

private

Referenced by Cogs::Interpolator< T >::cancel(), Cogs::Interpolator< T >::isProcessing(), Cogs::Interpolator< T >::process(), Cogs::Interpolator< T >::setTarget(), and Cogs::Interpolator< T >::snapToTarget().

mStart

template<typename T >

T Cogs::Interpolator< T >::mStart

private

Referenced by Cogs::Interpolator< T >::process(), and Cogs::Interpolator< T >::setTarget().

mTarget

template<typename T >

T Cogs::Interpolator< T >::mTarget

private

Referenced by Cogs::Interpolator< T >::getTarget(), Cogs::Interpolator< T >::process(), Cogs::Interpolator< T >::setTarget(), and Cogs::Interpolator< T >::snapToTarget().

mTimer

template<typename T >

Timer Cogs::Interpolator< T >::mTimer

private

Referenced by Cogs::Interpolator< T >::getTime(), Cogs::Interpolator< T >::process(), and Cogs::Interpolator< T >::setTarget().

---

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

• Source/Geometry/Interpolator.h