Template class for keyframe animations. More...

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

Inheritance diagram for kanzi::KeyframeAnimation< TValueType >:

Classes
class	BezierKeyframe

class	Keyframe

class	LinearKeyframe

class	StepKeyframe

Public Types
typedef unique_ptr< Keyframe >	KeyframePtr

typedef map< chrono::milliseconds, Keyframe * >	KeyframeContainer

typedef unique_ptr< StepKeyframe >	StepKeyframePtr

typedef unique_ptr< LinearKeyframe >	LinearKeyframePtr

typedef unique_ptr< BezierKeyframe >	BezierKeyframePtr

Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
	~KeyframeAnimation ()

void	addKeyframe (chrono::milliseconds time, KeyframePtr keyframePtr)

void	addStepKeyframe (chrono::milliseconds time, const TValueType &value)

void	addLinearKeyframe (chrono::milliseconds time, const TValueType &value)

void	addBezierKeyframe (chrono::milliseconds time, const TValueType &value, const Vector2 &p0, const Vector2 &p1)

virtual TValueType	getValue (const TValueType &currentValue, chrono::milliseconds time) KZ_OVERRIDE
	Returns new animated value given current value and time. More...

Public Member Functions inherited from kanzi::AbstractAnimation
virtual	~AbstractAnimation ()
	Destructor. More...

optional< chrono::milliseconds >	getDuration ()
	Returns the duration of the animation. More...

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

Domain *	getDomain () const
	Returns the domain the object belongs to. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object. More...

virtual const Metaclass *	getDynamicMetaclass () const KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...

AppliedStyleEntry *	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

void	unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)

void	applyObjectStyles ()
	Apply all styles for an object node. More...

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles. More...

Public Member Functions inherited from kanzi::MetaObject
virtual	~MetaObject ()

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

Public Member Functions inherited from kanzi::PropertyObject
	PropertyObject ()

virtual	~PropertyObject ()

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property. More...

void	removeKzbProperties ()

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property. More...

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers. More...

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value. More...

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers. More...

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property. More...

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property. More...

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object. More...

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object. More...

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications. More...

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void owner)

template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
	Gets number of current notification handlers for given property type. More...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

static shared_ptr< KeyframeAnimation >	create (Domain *domain)

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info. More...

Protected Member Functions
	KeyframeAnimation (Domain *domain)
	Constructor. More...

virtual optional< chrono::milliseconds >	getDurationOverride () KZ_OVERRIDE
	Virtual function the derived classes should overload to return duration. More...

Protected Member Functions inherited from kanzi::ValueAnimation< TValueType >
	ValueAnimation (Domain *domain)
	Constructor. More...

Protected Member Functions inherited from kanzi::AbstractAnimation
	AbstractAnimation (Domain *domain)
	Constructor. More...

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
	MetaObject ()

void	initialize ()

Protected Member Functions inherited from kanzi::PropertyObject
void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void owner)

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
	Copy local value from property storage. More...

PropertyStorageContainer::iterator	beginPropertyStorage ()

PropertyStorageContainer::iterator	endPropertyStorage ()

virtual void	notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)

void	onCopy (const PropertyObject &other)

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

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

Template class for keyframe animations.

Template Parameters

TValueType Defines the type of the value you want to animate. For example, float, bool, int, ColorRGBA.

The Kanzi animation system consists animations and timelines: animations define how to animate a property, and timelines map the animations to time and to objects you want to animate.

Keyframe animation uses keyframes that define the property value and time at which the animation reaches that value. In Kanzi you can create linear, step, and Bezier keyframes.

Examples

To create a keyframe animation:

        // Create a float keyframe animation.
        FloatKeyframeAnimationSharedPtr keyframeAnimation = FloatKeyframeAnimation::create(domain);
        // Create and add keyframes to the keyframe animation. This keyframe animation contains two linear keyframes.
        // Create a linear keyframe at second 0 with the value 0.
        keyframeAnimation->addLinearKeyframe(chrono::seconds::zero(), 0.0f);
        // Create a linear keyframe at second 1 with the value 100.
        keyframeAnimation->addLinearKeyframe(chrono::seconds(1), 100.0f);

To animate a property value in a node using a keyframe animation:

        // Create a property timeline and apply the keyframeAnimation keyframe animation to the Layout Width property
        // to animate the width of the current node.
        PropertyAnimationTimelineSharedPtr propertyTimeline = PropertyAnimationTimeline::create(domain, ".", Node2D::WidthProperty, keyframeAnimation);

To animate a property field value in a node using a keyframe animation:

        // Create a property field animation timeline and apply it to the Render Transformation property of the current node.
        PropertyFieldAnimationTimelineSharedPtr propertyFieldTimeline = PropertyFieldAnimationTimeline::create(domain, ".", Node2D::RenderTransformationProperty);
        // Rotate the current node by animating the Rotation Z property field of the Render Transformation property
        // with the keyframeAnimation keyframe animation.
        propertyFieldTimeline->addEntry(PropertyFieldRotationZ, keyframeAnimation);

To create a keyframe animation that uses Bezier keyframes to move an object on a sideways figure eight shaped path:

        // Create two float keyframe animations: one to animate the object on the x axis,
        // the other to animate the object on the y axis.
        // Create float keyframe animation keyframeAnimationX that uses linear keyframes
        // to animate the movement of the object on the x axis.
        FloatKeyframeAnimationSharedPtr keyframeAnimationX = FloatKeyframeAnimation::create(domain);
        // Create a linear keyframe at second 0 with the value 0.
        keyframeAnimationX->addLinearKeyframe(chrono::seconds::zero(), 0.0f);
        // Create a linear keyframe at second 4 with the value 4.
        // At this keyframe the object reaches the furthest point on the x axis.
        keyframeAnimationX->addLinearKeyframe(chrono::seconds(4), 4.0f);
        // Create a linear keyframe at second 8 with the value 0.
        // At this keyframe the object returns to the same position it had at the first keyframe.
        keyframeAnimationX->addLinearKeyframe(chrono::seconds(8), 0.0f);
        // Create float keyframe animation keyframeAnimationY that uses Bezier keyframes
        // to animate the movement of the object on the y axis.
        FloatKeyframeAnimationSharedPtr keyframeAnimationY = FloatKeyframeAnimation::create(domain);
        // Create a linear keyframe at second 0 with the value 0. When you use Bezier keyframes,
        // you can use any type of keyframe for the first keyframe, because you need this keyframe
        // only to provide the information for the starting position.
        keyframeAnimationY->addLinearKeyframe(chrono::seconds::zero(), 0.0f);
        // Create a Bezier keyframe at second 4 with the value 0 and two control points.
        // You use the control points to set the position of the keyframe.
        keyframeAnimationY->addBezierKeyframe(chrono::seconds(4), 0.0f, Vector2(0.5f, 4.0f), Vector2(0.5f, -4.0f));
        // Create a Bezier keyframe at second 8 with the value 0 and two control points.
        // This keyframe uses the same control points, but because the keyframeAnimationX
        // animation moves the object on the x axis back to its starting position, this keyframe
        // is a mirror image of the previous keyframe.
        keyframeAnimationY->addBezierKeyframe(chrono::seconds(8), 0.0f, Vector2(0.5f, 4.0f), Vector2(0.5f, -4.0f));
        // Create a property field animation timeline and apply it to the Render Transformation property of the current node.
        PropertyFieldAnimationTimelineSharedPtr timeline = PropertyFieldAnimationTimeline::create(domain, ".", Node3D::RenderTransformationProperty);
        // Move the current node on the x axis by animating the Translation X property field of the Render Transformation property
        // with the keyframeAnimationX keyframe animation.
        timeline->addEntry(PropertyFieldTranslationX, keyframeAnimationX);
        // Move the current node on the y axis by animating the Translation Y property field of the Render Transformation property
        // with the keyframeAnimationY keyframe animation.
        timeline->addEntry(PropertyFieldTranslationY, keyframeAnimationY);

To play an animation regardless of the timeline type:

        // Create the playback context and the timeline playback for the node defined in the item2d.
        SceneGraphTimelinePlaybackContext context(*item2d);
        // Create the playback for the timeline defined in the propertyFieldTimeline.
        TimelinePlaybackSharedPtr playback = propertyFieldTimeline->createPlayback(context);
        // Start the animation.
        domain->getRootTimelineClock()->addTimelinePlayback(playback);

Member Typedef Documentation

template<typename TValueType >

typedef unique_ptr<Keyframe> kanzi::KeyframeAnimation< TValueType >::KeyframePtr

template<typename TValueType >

typedef map<chrono::milliseconds, Keyframe*> kanzi::KeyframeAnimation< TValueType >::KeyframeContainer

template<typename TValueType >

typedef unique_ptr<StepKeyframe> kanzi::KeyframeAnimation< TValueType >::StepKeyframePtr

template<typename TValueType >

typedef unique_ptr<LinearKeyframe> kanzi::KeyframeAnimation< TValueType >::LinearKeyframePtr

template<typename TValueType >

typedef unique_ptr<BezierKeyframe> kanzi::KeyframeAnimation< TValueType >::BezierKeyframePtr

Constructor & Destructor Documentation

template<typename TValueType >

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

inline

template<typename TValueType >

kanzi::KeyframeAnimation< TValueType >::KeyframeAnimation ( Domain * domain )

inlineexplicitprotected

Constructor.

Member Function Documentation

template<typename TValueType >

static PropertyTypeEditorInfoSharedPtr kanzi::KeyframeAnimation< TValueType >::makeEditorInfo ( )

inlinestatic

template<typename TValueType >

static shared_ptr<KeyframeAnimation> kanzi::KeyframeAnimation< TValueType >::create ( Domain * domain )

inlinestatic

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::addKeyframe	(	chrono::milliseconds	time,
		KeyframePtr	keyframePtr
	)

inline

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::addStepKeyframe	(	chrono::milliseconds	time,
		const TValueType &	value
	)

inline

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::addLinearKeyframe	(	chrono::milliseconds	time,
		const TValueType &	value
	)

inline

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::addBezierKeyframe	(	chrono::milliseconds	time,
		const TValueType &	value,
		const Vector2 &	p0,
		const Vector2 &	p1
	)

inline

template<typename TValueType >

virtual TValueType kanzi::KeyframeAnimation< TValueType >::getValue	(	const TValueType &	currentValue,
		chrono::milliseconds	time
	)

inlinevirtual

Returns new animated value given current value and time.

Classes derived from ValueAnimation define data and algorithms to calculate the value returned by this function.

Parameters

currentValue Current value that is used as basis for animation calculations.

Implements kanzi::ValueAnimation< TValueType >.

template<typename TValueType >

virtual optional<chrono::milliseconds> kanzi::KeyframeAnimation< TValueType >::getDurationOverride ( )

inlineprotectedvirtual

Virtual function the derived classes should overload to return duration.

Default implementation returns nullopt to indicate infinite animation.

Reimplemented from kanzi::AbstractAnimation.

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

kanzi/core.ui/animation/keyframe_animation.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

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

Examples

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

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