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 fTimePercentage) override
virtual void	Reset () overridefinal
Public Member Functions inherited from CYITimeInterpolator
virtual	~CYITimeInterpolator ()
Public Member Functions inherited from CYIScriptableRTTIObject
	CYIScriptableRTTIObject ()
virtual	~CYIScriptableRTTIObject ()
virtual const CYIRuntimeTypeInfo *	GetRuntimeTypeInfoForScriptObject () const override
Public Member Functions inherited from CYIScriptableObject
	CYIScriptableObject ()
	CYIScriptableObject (const CYIScriptableObject &other)
CYIScriptableObject &	operator= (const CYIScriptableObject &other)
virtual	~CYIScriptableObject ()
CYIBindingImplementation *	GetBindingImplementation () const
void	SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)

Additional Inherited Members
Protected Member Functions inherited from CYIScriptableRTTIObject
virtual std::pair< const CYIRuntimeTypeInfo *, const void * >	GetRuntimeTypeInfoWithObject () const =0

Constructor & Destructor Documentation

CYIInterpolatePath::CYIInterpolatePath

(

)

CYIInterpolatePath::CYIInterpolatePath

(

std::unique_ptr< CYIPath >

pPath

)

Creates an interpolator from pPath.

virtual CYIInterpolatePath::~CYIInterpolatePath ( )

virtual

Member Function Documentation

virtual float CYIInterpolatePath::Interpolate ( float  fTimePercentage )

overridevirtual

Remaps the value fTimePercentage 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.

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.

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:

• animation/YiInterpolatePath.h