You.i Engine
CYIInterpolatePath Class Reference

Detailed Description

An interpolator that maps a range onto a CYIPath.

This interpolator maps the incoming range onto a CYIPath object.

Note
Unlike most interpolator classes, this interpolator is stateful. Therefore, it is important to call Reset if the interpolator is reused to interpolator onto a new range.
If an instance of this class is created using the default constructor, the path must be set by using the SetPath function.
See also
CYIPath

#include <animation/YiInterpolatePath.h>

Inheritance diagram for CYIInterpolatePath:

Public Member Functions

 CYIInterpolatePath ()
 
 CYIInterpolatePath (std::unique_ptr< CYIPath > pPath)
 
virtual ~CYIInterpolatePath ()
 
void SetPath (std::unique_ptr< CYIPath > pPath)
 
virtual float Interpolate (float timePercentage) override
 
virtual void Reset () override final
 
- Public Member Functions inherited from CYITimeInterpolator
virtual ~CYITimeInterpolator ()
 

Constructor & Destructor Documentation

◆ CYIInterpolatePath() [1/2]

CYIInterpolatePath::CYIInterpolatePath ( )

◆ CYIInterpolatePath() [2/2]

CYIInterpolatePath::CYIInterpolatePath ( std::unique_ptr< CYIPath pPath)

Creates an interpolator from pPath.

◆ ~CYIInterpolatePath()

virtual CYIInterpolatePath::~CYIInterpolatePath ( )
virtual

Member Function Documentation

◆ Interpolate()

virtual float CYIInterpolatePath::Interpolate ( float  timePercentage)
overridevirtual

Remaps the value timePercentage onto a new range and returns the remapped value. The range used to remap onto is dependent on the specific type of interpolator used.

Implements CYITimeInterpolator.

◆ Reset()

virtual void CYIInterpolatePath::Reset ( )
finaloverridevirtual

Resets the state of this interpolator. The interpolator will act as if it has newly been constructed.

Reimplemented from CYITimeInterpolator.

◆ SetPath()

void CYIInterpolatePath::SetPath ( std::unique_ptr< CYIPath pPath)

Sets the path used by this interpolator.


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