soui 5.0.0.1
Soui5 Doc
 
All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Loading...
Searching...
No Matches
SAnticipateOvershootInterpolator Class Reference

An interpolator where the change starts backward before moving forward and overshoots the target. More...

#include <SInterpolatorImpl.h>

Public Member Functions

 SAnticipateOvershootInterpolator (float tension=2.0f, float extraTension=1.5f)
 Constructor for SAnticipateOvershootInterpolator.
 
float getInterpolation (float input) SCONST OVERRIDE
 Gets the interpolated value for the given input.
 
virtual HRESULT SetAttribute (const SNS::SStringW &amp;amp;amp;amp;strAttribName, const SNS::SStringW &amp;amp;amp;amp;strValue, BOOL bLoading=FALSE)
 Attributes for SAnticipateOvershootInterpolator.
 

Detailed Description

An interpolator where the change starts backward before moving forward and overshoots the target.

Definition at line 152 of file SInterpolatorImpl.h.

Constructor & Destructor Documentation

◆ SAnticipateOvershootInterpolator()

SAnticipateOvershootInterpolator::SAnticipateOvershootInterpolator ( float tension = 2.0f,
float extraTension = 1.5f )

Constructor for SAnticipateOvershootInterpolator.

Parameters
tensionAmount of anticipation/overshoot. When tension equals 0.0f, there is no anticipation/overshoot and the interpolator becomes a simple acceleration/deceleration interpolator.
extraTensionExtra amount by which to multiply the tension. For instance, to get the same overshoot as an OvershootInterpolator with a tension of 2.0f, you would use an extraTension of 1.5f.

Definition at line 105 of file SInterpolatorImpl.cpp.

Member Function Documentation

◆ getInterpolation()

float SAnticipateOvershootInterpolator::getInterpolation ( float input)

Gets the interpolated value for the given input.

Parameters
inputThe input value between 0 and 1.
Returns
The interpolated value.

Definition at line 83 of file SInterpolatorImpl.cpp.

◆ SetAttribute()

virtual HRESULT SAnticipateOvershootInterpolator::SetAttribute ( const SNS::SStringW &amp;amp;amp;amp; strAttribName,
const SNS::SStringW &amp;amp;amp;amp; strValue,
BOOL bLoading = FALSE )
inlinevirtual

Attributes for SAnticipateOvershootInterpolator.

< Amount of anticipation/overshoot. Extra amount by which to multiply the tension.

Definition at line 202 of file SInterpolatorImpl.h.


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