khanat-opennel-code/code/nel/include/nel/misc/mouse_smoother.h
2010-05-06 02:08:41 +02:00

79 lines
2.6 KiB
C++

// NeL - MMORPG Framework <http://dev.ryzom.com/projects/nel/>
// Copyright (C) 2010 Winch Gate Property Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <http://www.gnu.org/licenses/>.
#ifndef NL_MOUSE_SMOOTHER_H
#define NL_MOUSE_SMOOTHER_H
#include "types_nl.h"
#include "vector_2f.h"
namespace NLMISC
{
/**
* This smooth position of mouse using cubic splines.
* The mouse is sampled at the given period. The higher the period, the smoother the movement.
* However there is a delay of 2 * samplingPeriod between the user moving the mouse and the pointer reaching
* the wanted position.
*
* \author Nicolas Vizerie
* \author Nevrax France
* \date 1/2004
*/
class CMouseSmoother
{
public:
// create a mouse smoother with the given sampling period.
CMouseSmoother(double samplingPeriod = 0.2);
/** Change the sampling period. The longer it lasts, the more smooth the movement.
* NB : this reset the smoother
*/
void setSamplingPeriod(double period);
// Get the sampling period
double getSamplingPeriod() const { return _SamplingPeriod; }
// Reset smoother. The next returned position will be the exact position of mouse (no smoothing with previous position is done)
void reset();
// \return trueif no sampling has occured since last resetor construction
bool isReseted() const { return !_Init; }
// Sample pos, and return smoothed position
CVector2f samplePos(const CVector2f &wantedPos, double date);
private:
// sample of mouse position
class CSample
{
public:
double Date;
CVector2f Pos;
public:
// default ctor
CSample() {}
// ctor with pos & date
CSample(double date, const NLMISC::CVector2f &pos) : Date(date), Pos(pos)
{
}
};
double _SamplingPeriod;
bool _Init;
/** 4 samples are needed to compute smoothed position :
* Sample 0 & 2 are used to compute tangent at sample 1
* Sample 1 & 3 are used to compute tangent at sample 2
*/
CSample _Sample[4];
};
} // NLMISC
#endif