IEasyEaseAnimator Class Reference

Interface for defining animation behaviors with easing and interpolation. More...

#include <IEasyEaseAnimator.h>

Inheritance diagram for IEasyEaseAnimator:

Public Types
enum	InterpolationMethod { Cosine , Bounce , Linear , Overshoot }
	Enumeration of interpolation methods for animations. More...

Public Member Functions
virtual void	SetConstants (uint16_t dictionaryValue, float springConstant, float damping)=0
	Sets the spring and damping constants for a parameter.
virtual float	GetValue (uint16_t dictionaryValue)=0
	Retrieves the current value of a parameter.
virtual float	GetTarget (uint16_t dictionaryValue)=0
	Retrieves the target value of a parameter.
virtual void	AddParameter (float *parameter, uint16_t dictionaryValue, uint16_t frames, float basis, float goal)=0
	Adds a new parameter to the animator.
virtual void	AddParameterFrame (uint16_t dictionaryValue, float value)=0
	Adds a single frame value to a parameter.
virtual void	SetInterpolationMethod (uint16_t dictionaryValue, InterpolationMethod interpMethod)=0
	Sets the interpolation method for a parameter.
virtual void	Reset ()=0
	Resets the animator to its initial state.
virtual void	SetParameters ()=0
	Applies the current animation values to the parameters.
virtual void	Update ()=0
	Updates the animator, advancing all animations.

Detailed Description

Interface for defining animation behaviors with easing and interpolation.

The IEasyEaseAnimator interface provides methods for managing animated parameters, supporting interpolation methods, damped spring constants, and parameter transitions.

Definition at line 26 of file IEasyEaseAnimator.h.

Member Enumeration Documentation

InterpolationMethod

enum InterpolationMethod

Enumeration of interpolation methods for animations.

Provides various interpolation techniques for smooth and dynamic transitions.

Enumerator
Cosine	Smooth cosine interpolation.
Bounce	Bouncy effect during interpolation.
Linear	Straight linear interpolation.
Overshoot	Interpolation with overshooting behavior.

Definition at line 34 of file IEasyEaseAnimator.h.

Member Function Documentation

AddParameter()

virtual void AddParameter ( float *  parameter, uint16_t  dictionaryValue, uint16_t  frames, float  basis, float  goal  )

pure virtual

Adds a new parameter to the animator.

Parameters

parameter	A pointer to the parameter to animate.
dictionaryValue	The parameter's dictionary identifier.
frames	The number of frames for the transition.
basis	The initial basis value.
goal	The target goal value.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

AddParameterFrame()

virtual void AddParameterFrame ( uint16_t  dictionaryValue, float  value  )

pure virtual

Adds a single frame value to a parameter.

Parameters

dictionaryValue	The parameter's dictionary identifier.
value	The frame value to add.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

GetTarget()

virtual float GetTarget ( uint16_t  dictionaryValue )

pure virtual

Retrieves the target value of a parameter.

Parameters

dictionaryValue

The parameter's dictionary identifier.

Returns

The target value of the parameter.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

GetValue()

virtual float GetValue ( uint16_t  dictionaryValue )

pure virtual

Retrieves the current value of a parameter.

Parameters

dictionaryValue

The parameter's dictionary identifier.

Returns

The current value of the parameter.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

Reset()

virtual void Reset ( )

pure virtual

Resets the animator to its initial state.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

SetConstants()

virtual void SetConstants ( uint16_t  dictionaryValue, float  springConstant, float  damping  )

pure virtual

Sets the spring and damping constants for a parameter.

Parameters

dictionaryValue	The parameter's dictionary identifier.
springConstant	The spring constant to set.
damping	The damping constant to set.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

SetInterpolationMethod()

virtual void SetInterpolationMethod ( uint16_t  dictionaryValue, InterpolationMethod  interpMethod  )

pure virtual

Sets the interpolation method for a parameter.

Parameters

dictionaryValue	The parameter's dictionary identifier.
interpMethod	The interpolation method to set.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

SetParameters()

virtual void SetParameters ( )

pure virtual

Applies the current animation values to the parameters.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

Update()

virtual void Update ( )

pure virtual

Updates the animator, advancing all animations.

Implemented in EasyEaseAnimator< maxParameters >, EasyEaseAnimator< 20 >, EasyEaseAnimator< 21 >, EasyEaseAnimator< 25 >, EasyEaseAnimator< 30 >, EasyEaseAnimator< 60 >, and EasyEaseAnimator< materialCount >.

---

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

• IEasyEaseAnimator.h