linearInterpolator.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*********************************************************************************/
 
#pragma once
 
//! \file linearInterpolator.h
//! \brief Provides a template class for linear interpolation between values
 
 
namespace makVre
{
//! \brief Linear interpolation template class
//!
//! This template class provides linear interpolation between a start and end value
//! over a specified time period. Specializations are provided for float, double,
//! and DtVector types.
//!
//! \tparam T The type of value to interpolate
template <typename T>
class DtLinearInterpolator
{
public:
   //! \brief Constructor
   //!
   //! Initializes the interpolator with start and end values and the time period
   //!
   //! \param start The starting value
   //! \param stop The ending value
   //! \param period The time period over which to interpolate (in seconds)
   DtLinearInterpolator(T start, T stop, double period)
      : myStart(start)
      , myEnd(stop)
      , myCurrentValue(start)
      , myCurrentTime(0)
      , myPeriod(period)
   {
   }
 
   //! \brief Destructor
   ~DtLinearInterpolator() {}
 
   //! \brief Updates the interpolation based on elapsed time
   //!
   //! This function advances the interpolation by the given time step,
   //! recalculating the current value based on the elapsed time.
   //! Specialized implementations are provided for float, double, and DtVector.
   //!
   //! \param dt The time step in seconds
   void tick(double dt);
 
   //! \brief Gets the current interpolated value
   //!
   //! \return The current value of the interpolation
   T value() const { return myCurrentValue; }
 
   //! \brief Checks if the interpolation has completed
   //!
   //! \return true if the current time has reached or exceeded the period
   bool isDone() const;
 
   //! \brief Resets the interpolation to the beginning
   //!
   //! Sets the current value back to the start value and resets the time to zero
   void reset();
 
   //! \brief Resets the interpolation with new parameters
   //!
   //! \param start The new starting value
   //! \param stop The new ending value
   //! \param period The new time period (in seconds)
   void reset(T start, T stop, double period);
 
   //! \brief Gets the start value
   //!
   //! \return The start value of the interpolation
   T start() const { return myStart; }
 
   //! \brief Gets the end value
   //!
   //! \return The end value of the interpolation
   T stop() const { return myEnd; }
 
   //! \brief Gets the time remaining in the interpolation
   //!
   //! \return The remaining time in seconds
   double timeRemaining() const { return myPeriod - myCurrentTime; }
 
protected:
   //! \brief The starting value
   T myStart;
 
   //! \brief The ending value
   T myEnd;
 
   //! \brief The current interpolated value
   T myCurrentValue;
 
   //! \brief The total time period for the interpolation (in seconds)
   double myPeriod;
 
   //! \brief The current elapsed time (in seconds)
   double myCurrentTime;
};
 
//! \brief Checks if the interpolation has completed
//!
//! \return true if the current time has reached or exceeded the period
template <typename T>
bool DtLinearInterpolator<T>::isDone() const
{
   return myCurrentTime >= myPeriod;
}
 
//! \brief Resets the interpolation to the beginning
//!
//! Sets the current value back to the start value and resets the time to zero
template <typename T>
void DtLinearInterpolator<T>::reset()
{
   myCurrentValue = myStart;
   myCurrentTime = 0.0;
}
 
//! \brief Resets the interpolation with new parameters
//!
//! \param start The new starting value
//! \param stop The new ending value
//! \param period The new time period (in seconds)
template <typename T>
void DtLinearInterpolator<T>::reset(T start, T stop, double period)
{
   myStart = start;
   myEnd = stop;
   myPeriod = period;
   myCurrentValue = myStart;
   myCurrentTime = 0.0;
}
 
} // namespace makVre