kanzi::KeyframeAnimation< TValueType >::BezierKeyframe Class Reference

Use bezier keyframes to animate property value along a bezier curve. More...

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

Inheritance diagram for kanzi::KeyframeAnimation< TValueType >::BezierKeyframe:

Public Member Functions
	BezierKeyframe ()
	Constructor.
	BezierKeyframe (TValueType value, const Vector2 &p0, const Vector2 &p1)
	Constructor.
Vector2	getControlPoint0 () const
	Returns the first control point of the keyframe.
Vector2	getControlPoint1 () const
	Returns the second control point of the keyframe.
TValueType	getValue (const TValueType &currentValue, float normalizedTime) override
	Returns the value for the animated property at a given time.
void	setControlPoint0 (Vector2 controlPoint)
	Sets the first control point for a keyframe.
void	setControlPoint1 (Vector2 controlPoint)
	Sets the second control point for a keyframe.
void	setControlPoints (const Vector2 &p0, const Vector2 &p1)
	Sets control points for a keyframe.
Public Member Functions inherited from kanzi::KeyframeAnimation< TValueType >::Keyframe
TValueType	getKeyValue () const
	Returns the keyframe value of the animated property.
	Keyframe ()
	Constructor.
	Keyframe (TValueType value)
	Constructor.
void	setKeyValue (const TValueType &keyValue)
	Sets the keyframe value for a keyframe.
virtual	~Keyframe ()

Static Public Member Functions
static BezierKeyframePtr	create (TValueType value, const Vector2 &p0, const Vector2 &p1)
	Creates a bezier keyframe.

Detailed Description

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

Use bezier keyframes to animate property value along a bezier curve.

A Bezier keyframe consists of two control points in addition to a keyframe value for the animated property. A control point is a pair of a floating point numbers stored in Vector2:

• The X coordinate of a control point specifies the animation time of that control point. The value of the control point is defined in relative units, where 0.0 corresponds to the time of the previous keyframe and 1.0 corresponds to the time of the current keyframe.
• The Y coordinate of a control point specifies the value of the animated property of that control point. The value of the control point is defined in the same absolute units as the value of the keyframe.

Constructor & Destructor Documentation

BezierKeyframe() [1/2]

template<typename TValueType >

kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::BezierKeyframe ( )

inlineexplicit

Constructor.

BezierKeyframe() [2/2]

template<typename TValueType >

kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::BezierKeyframe ( TValueType value, const Vector2 & p0, const Vector2 & p1 )

inlineexplicit

Constructor.

Parameters

value	The keyframe value of the animated property.
p0	The first control point of the keyframe.
p1	The second control point of the keyframe.

Member Function Documentation

create()

template<typename TValueType >

static BezierKeyframePtr kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::create ( TValueType value, const Vector2 & p0, const Vector2 & p1 )

inlinestatic

Creates a bezier keyframe.

Parameters

value	The keyframe value of the animated property.
p0	The first control point of the keyframe.
p1	The second control point of the keyframe.

setControlPoints()

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::setControlPoints ( const Vector2 & p0, const Vector2 & p1 )

inline

Sets control points for a keyframe.

Parameters

p0	The first control point of the keyframe.
p1	The second control point of the keyframe.

getControlPoint0()

template<typename TValueType >

Vector2 kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::getControlPoint0 ( ) const

inline

Returns the first control point of the keyframe.

Returns

The first control point of the keyframe.

setControlPoint0()

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::setControlPoint0 ( Vector2 controlPoint )

inline

Sets the first control point for a keyframe.

Parameters

controlPoint

A control point that you want to use as the first control point of the keyframe.

getControlPoint1()

template<typename TValueType >

Vector2 kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::getControlPoint1 ( ) const

inline

Returns the second control point of the keyframe.

Returns

The second control point of the keyframe.

setControlPoint1()

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::setControlPoint1 ( Vector2 controlPoint )

inline

Sets the second control point for a keyframe.

Parameters

controlPoint

A control point that you want to use as the second control point of the keyframe.

getValue()

template<typename TValueType >

TValueType kanzi::KeyframeAnimation< TValueType >::BezierKeyframe::getValue ( const TValueType & currentValue, float normalizedTime )

inlineoverridevirtual

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

Parameters

currentValue	The current value of the animated property.
normalizedTime	The 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.

Implements kanzi::KeyframeAnimation< TValueType >::Keyframe.

---

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

• kanzi/core.ui/animation/keyframe_animation.hpp