CosinusInterpolator< KeyType > Class Template Reference

Cosinus interpolator. More...

#include <CosinusInterpolator.h>

Inheritance diagram for CosinusInterpolator< KeyType >:

Public Member Functions
	CosinusInterpolator ()=default
	CosinusInterpolator (const Key< KeyType > &leftKey, const Key< KeyType > &rightKey, UPtr< const IInterpolator< KeyType > > &leftInterpolator, UPtr< const IInterpolator< KeyType > > &rightInterpolator)
	Constructor for default interpolator creation function. More...
	~CosinusInterpolator ()=default
virtual KeyType	Interpolate (TimeType time, Key< KeyType > &left, Key< KeyType > &right) override
	Main function invoked by evaluator. More...
virtual void	Update (const Key< KeyType > &leftKey, const Key< KeyType > &rightKey, UPtr< const IInterpolator< KeyType > > &leftInterpolator, UPtr< const IInterpolator< KeyType > > &rightInterpolator) override
	Function updates interpolator, when left or right key value changes. More...
virtual KeyType	LeftTangent (const Key< KeyType > &left, const Key< KeyType > &right) const override
	Returns curve tangent. Function can be used by surrounding interpolators to smooth curve. More...
virtual KeyType	RightTangent (const Key< KeyType > &left, const Key< KeyType > &right) const override
	Returns curve tangent. Function can be used by surrounding interpolators to smooth curve. More...
Public Member Functions inherited from IInterpolator< KeyType >
	IInterpolator ()=default
virtual	~IInterpolator ()=default

Detailed Description

template<typename KeyType>
class CosinusInterpolator< KeyType >

Cosinus interpolator.

Constructor & Destructor Documentation

template<typename KeyType >

CosinusInterpolator< KeyType >::CosinusInterpolator ( )

explicitdefault

template<typename KeyType >

CosinusInterpolator< KeyType >::CosinusInterpolator ( const Key< KeyType > &  leftKey, const Key< KeyType > &  rightKey, UPtr< const IInterpolator< KeyType > > &  leftInterpolator, UPtr< const IInterpolator< KeyType > > &  rightInterpolator  )

explicit

Constructor for default interpolator creation function.

template<typename KeyType >

CosinusInterpolator< KeyType >::~CosinusInterpolator ( )

default

Member Function Documentation

template<typename KeyType >

KeyType CosinusInterpolator< KeyType >::Interpolate ( TimeType  time, Key< KeyType > &  left, Key< KeyType > &  right  )

inlineoverridevirtual

Main function invoked by evaluator.

Implements IInterpolator< KeyType >.

template<typename KeyType >

KeyType CosinusInterpolator< KeyType >::LeftTangent ( const Key< KeyType > &  left, const Key< KeyType > &  right  ) const

inlineoverridevirtual

Returns curve tangent. Function can be used by surrounding interpolators to smooth curve.

Implements IInterpolator< KeyType >.

template<typename KeyType >

KeyType CosinusInterpolator< KeyType >::RightTangent ( const Key< KeyType > &  left, const Key< KeyType > &  right  ) const

inlineoverridevirtual

Returns curve tangent. Function can be used by surrounding interpolators to smooth curve.

Implements IInterpolator< KeyType >.

template<typename KeyType >

void CosinusInterpolator< KeyType >::Update ( const Key< KeyType > &  leftKey, const Key< KeyType > &  rightKey, UPtr< const IInterpolator< KeyType > > &  leftInterpolator, UPtr< const IInterpolator< KeyType > > &  rightInterpolator  )

inlineoverridevirtual

Function updates interpolator, when left or right key value changes.

Note

Left or right interpolator can be nullptr, but keys always exist.

Implements IInterpolator< KeyType >.

---

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

• D:/ProgramyVS/SWLibraries/swCommonLib/ParameterAnimation/Interpolators/CosinusInterpolator.h