Kanzi  3.9.4
Kanzi Engine API
kanzi::KeyframeAnimation< TValueType >::Keyframe Class Referenceabstract

Keyframe defines a value for the animated property at a specific time in an animation timeline. More...

#include <kanzi/core.ui/animation/keyframe_animation.hpp>

Inheritance diagram for kanzi::KeyframeAnimation< TValueType >::Keyframe:
[legend]

Public Member Functions

TValueType getKeyValue () const
 Returns the keyframe value of the animated property. More...
 
virtual TValueType getValue (const TValueType &currentValue, float normalizedTime)=0
 Returns the value for the animated property at a given time. More...
 
 Keyframe ()
 Constructor. More...
 
 Keyframe (TValueType value)
 Constructor. More...
 
void setKeyValue (const TValueType &keyValue)
 Sets the keyframe value for a keyframe. More...
 
virtual ~Keyframe ()
 

Detailed Description

template<typename TValueType>
class kanzi::KeyframeAnimation< TValueType >::Keyframe

Keyframe defines a value for the animated property at a specific time in an animation timeline.

Constructor & Destructor Documentation

◆ Keyframe() [1/2]

template<typename TValueType >
kanzi::KeyframeAnimation< TValueType >::Keyframe::Keyframe ( )
inlineexplicit

Constructor.

◆ Keyframe() [2/2]

template<typename TValueType >
kanzi::KeyframeAnimation< TValueType >::Keyframe::Keyframe ( TValueType  value)
inlineexplicit

Constructor.

Parameters
valueThe keyframe value of the animated property.

◆ ~Keyframe()

template<typename TValueType >
virtual kanzi::KeyframeAnimation< TValueType >::Keyframe::~Keyframe ( )
inlinevirtual

Member Function Documentation

◆ getKeyValue()

template<typename TValueType >
TValueType kanzi::KeyframeAnimation< TValueType >::Keyframe::getKeyValue ( ) const
inline

Returns the keyframe value of the animated property.

Returns
The keyframe value of the animated property.

◆ setKeyValue()

template<typename TValueType >
void kanzi::KeyframeAnimation< TValueType >::Keyframe::setKeyValue ( const TValueType &  keyValue)
inline

Sets the keyframe value for a keyframe.

Parameters
keyValueThe keyframe value of the animated property.

◆ getValue()

template<typename TValueType >
virtual TValueType kanzi::KeyframeAnimation< TValueType >::Keyframe::getValue ( const TValueType &  currentValue,
float  normalizedTime 
)
pure virtual

Returns the value for the animated property at a given time.

Parameters
currentValueThe current value of the animated property.
normalizedTimeThe time at which you want to get the value of the animated property. 0.0 corresponds to the time of the previous keyframe. 1.0 corresponds to the time of this keyframe.
Returns
The value of the animated property at a given time.

Implemented in kanzi::KeyframeAnimation< TValueType >::BezierKeyframe, kanzi::KeyframeAnimation< TValueType >::LinearKeyframe, and kanzi::KeyframeAnimation< TValueType >::StepKeyframe.


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