Cogs.Core
Public Member Functions | Private Attributes | List of all members
Cogs::Interpolator< T > Class Template Reference

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
 

Detailed Description

template<typename T>
class Cogs::Interpolator< T >

Definition at line 21 of file Interpolator.h.

Constructor & Destructor Documentation

◆ Interpolator() [1/2]

template<typename T >
Cogs::Interpolator< T >::Interpolator ( T &  destination)
inline

Definition at line 23 of file Interpolator.h.

◆ Interpolator() [2/2]

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

Definition at line 26 of file Interpolator.h.

Member Function Documentation

◆ cancel()

template<typename T >
void Cogs::Interpolator< T >::cancel ( )
inline

Definition at line 68 of file Interpolator.h.

◆ getTarget()

template<typename T >
T Cogs::Interpolator< T >::getTarget ( ) const
inline

Definition at line 72 of file Interpolator.h.

◆ getTime()

template<typename T >
float Cogs::Interpolator< T >::getTime ( )
inline

Definition at line 71 of file Interpolator.h.

◆ getValue()

template<typename T >
T Cogs::Interpolator< T >::getValue ( ) const
inline

Definition at line 73 of file Interpolator.h.

◆ isProcessing()

template<typename T >
bool Cogs::Interpolator< T >::isProcessing ( ) const
inline

Definition at line 69 of file Interpolator.h.

◆ process()

template<typename T >
bool Cogs::Interpolator< T >::process ( )
inline

Definition at line 52 of file Interpolator.h.

◆ setTarget()

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

Definition at line 30 of file Interpolator.h.

◆ snapToTarget()

template<typename T >
void Cogs::Interpolator< T >::snapToTarget ( )
inline

Definition at line 45 of file Interpolator.h.

Member Data Documentation

◆ mDestination

template<typename T >
T& Cogs::Interpolator< T >::mDestination
private

Definition at line 76 of file Interpolator.h.

◆ mDuration

template<typename T >
float Cogs::Interpolator< T >::mDuration = 0.0f
private

Definition at line 81 of file Interpolator.h.

◆ mFunction

template<typename T >
EasingFn::Ptr Cogs::Interpolator< T >::mFunction = nullptr
private

Definition at line 80 of file Interpolator.h.

◆ mStart

template<typename T >
T Cogs::Interpolator< T >::mStart
private

Definition at line 77 of file Interpolator.h.

◆ mTarget

template<typename T >
T Cogs::Interpolator< T >::mTarget
private

Definition at line 78 of file Interpolator.h.

◆ mTimer

template<typename T >
Timer Cogs::Interpolator< T >::mTimer
private

Definition at line 79 of file Interpolator.h.

The documentation for this class was generated from the following file:
Generated by doxygen 1.9.6