interpolator.cpp

00001 
00002 /***************************************************************************
00003  *  interpolator.cpp - Interpolator
00004  *
00005  *  Created: Tue Nov 18 10:45:18 2008
00006  *  Copyright  2008  Tim Niemueller [www.niemueller.de]
00007  *
00008  ****************************************************************************/
00009 
00010 /*  This program is free software; you can redistribute it and/or modify
00011  *  it under the terms of the GNU General Public License as published by
00012  *  the Free Software Foundation; either version 2 of the License, or
00013  *  (at your option) any later version. A runtime exception applies to
00014  *  this software (see LICENSE.GPL_WRE file mentioned below for details).
00015  *
00016  *  This program is distributed in the hope that it will be useful,
00017  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
00018  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
00019  *  GNU Library General Public License for more details.
00020  *
00021  *  Read the full text in the LICENSE.GPL_WRE file in the doc directory.
00022  */
00023 
00024 #include <utils/math/interpolation/interpolator.h>
00025 
00026 namespace fawkes {
00027 #if 0 /* just to make Emacs auto-indent happy */
00028 }
00029 #endif
00030 
00031 /** @class Interpolator <utils/math/interpolation/interpolator.h>
00032  * Value interpolator.
00033  * The interpolator creates intermediate points given a starting and and
00034  * end point and time constraints. Times are supplied any chose time scale, it
00035  * only has to be a linear time measure. Common are miliseconds or seconds.
00036  * @author Tim Niemueller
00037  *
00038  * @fn float Interpolator::interpolate(float t_current, float t_end, float t_step, float v_start, float v_end)
00039  * Interpolate a point at a specific time.
00040  * @param t_current current time for which to calculate the intermediate point
00041  * @param t_end end time/total time. The start time is always 0.
00042  * @param t_step Time of a time slice for discrete intermediate interpolation
00043  * points. Set to 1 for maximum resolution.
00044  * @param v_start start value
00045  * @param v_end end value
00046  * @return interpolated value at time t_current between t_start and t_end.
00047  */
00048 
00049 /** Virtual empty descructor. */
00050 Interpolator::~Interpolator()
00051 {
00052 }
00053 
00054 } // end namespace fawkes
00055 

Generated on Tue Feb 22 13:32:28 2011 for Fawkes API by  doxygen 1.4.7