om::sound::base::LerpState< T, TimeType > Class Template Reference

A class that stores the state for a time-domain linear interpolation. More...

#include <omSoundLerpState.h>

Public Member Functions
	LerpState ()
	Create a new default linear interpolation state. More...
	LerpState (T newCurrent, T newTarget, TimeType newTime)
	Create a new linear interpolation state object with the given current, target, and time values. More...
Bool	isFinished () const
	Return whether or not the interpolation is finished. More...

Public Attributes
T	current
	The current interpolation value. More...
T	target
	The target value for the interpolation. More...
TimeType	time
	The time that it should take for the remaining interpolation to occur. More...

Detailed Description

template<typename T, typename TimeType = Float>
class om::sound::base::LerpState< T, TimeType >

A class that stores the state for a time-domain linear interpolation.

Constructor & Destructor Documentation

template<typename T , typename TimeType = Float>

om::sound::base::LerpState< T, TimeType >::LerpState ( )

inline

Create a new default linear interpolation state.

template<typename T , typename TimeType = Float>

om::sound::base::LerpState< T, TimeType >::LerpState ( T  newCurrent, T  newTarget, TimeType  newTime  )

inline

Create a new linear interpolation state object with the given current, target, and time values.

Member Function Documentation

template<typename T , typename TimeType = Float>

Bool om::sound::base::LerpState< T, TimeType >::isFinished ( ) const

inline

Return whether or not the interpolation is finished.

The interpolation is finished when the time remaining on the interpolation is equal to zero.

Member Data Documentation

template<typename T , typename TimeType = Float>

T om::sound::base::LerpState< T, TimeType >::current

The current interpolation value.

template<typename T , typename TimeType = Float>

T om::sound::base::LerpState< T, TimeType >::target

The target value for the interpolation.

template<typename T , typename TimeType = Float>

TimeType om::sound::base::LerpState< T, TimeType >::time

The time that it should take for the remaining interpolation to occur.

---

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

• omSoundLerpState.h