Template class for keyframe animations. More...

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

Inheritance diagram for kanzi::KeyframeAnimation< TValueType >:

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

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

class	LinearKeyframe
	Use linear keyframes to interpolate animated property value linearly between keyframes. More...

class	StepKeyframe
	Use Step keyframes to keep the value of the current keyframe constant up until the following keyframe. More...

Public Types
typedef unique_ptr< BezierKeyframe >	BezierKeyframePtr

typedef flat_map< chrono::milliseconds, KeyframePtr >	KeyframeContainer

typedef unique_ptr< Keyframe >	KeyframePtr

typedef unique_ptr< LinearKeyframe >	LinearKeyframePtr

typedef unique_ptr< StepKeyframe >	StepKeyframePtr

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

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

void	addKeyframe (chrono::milliseconds timeStamp, KeyframePtr keyframe)
	Adds a keyframe to given timestamp. More...

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

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

Keyframe &	getKeyFrame (size_t index)
	Returns keyframe by index. More...

size_t	getKeyFrameCount ()
	Returns the number of keyframes in this animation. More...

chrono::milliseconds	getTimestamp (size_t index)
	Returns timestamp by index. More...

TValueType	getValue (const TValueType &currentValue, chrono::milliseconds time) override
	Returns the value for the animated property at a given time. More...

Public Member Functions inherited from kanzi::AbstractAnimation
optional< chrono::milliseconds >	getDuration ()
	Returns the duration of the animation. More...

	~AbstractAnimation () override
	Destructor. More...

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...

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

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

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

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain. More...

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object. More...

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object. More...

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

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

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

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

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

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

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container. More...

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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...

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container. More...

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container. More...

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

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 >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, 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	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type. 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 >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type. 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...

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set. More...

void	removeKzbProperties ()
	Remove all KZB properties. More...

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

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

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

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

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

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

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

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	validatePropertyModifiers (AbstractPropertyType propertyType)

virtual	~PropertyObject ()

Static Public Member Functions
static shared_ptr< KeyframeAnimation >	create (Domain *domain)
	Creates Keyframe animation. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

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
optional< chrono::milliseconds >	getDurationOverride () override
	Virtual function the derived classes should overload to return duration. More...

	KeyframeAnimation (Domain *domain)
	Constructor. 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
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value. More...

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source. More...

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source. More...

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor. More...

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More...

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More...

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

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

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

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor. More...

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage. More...

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage. More...

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source. More...

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	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

◆ KeyframePtr

template<typename TValueType >

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

◆ KeyframeContainer

template<typename TValueType >

typedef flat_map<chrono::milliseconds, KeyframePtr> kanzi::KeyframeAnimation< TValueType >::KeyframeContainer

◆ StepKeyframePtr

template<typename TValueType >

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

◆ LinearKeyframePtr

template<typename TValueType >

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

◆ BezierKeyframePtr

template<typename TValueType >

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

Constructor & Destructor Documentation

◆ KeyframeAnimation()

template<typename TValueType >

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

inlineexplicitprotected

Constructor.

Member Function Documentation

◆ makeEditorInfo()

template<typename TValueType >

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

inlinestatic

◆ create()

template<typename TValueType >

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

inlinestatic

Creates Keyframe animation.

Parameters

domain The domain to which you want the keyframe animation to belong.

◆ addKeyframe()

template<typename TValueType >

void kanzi::KeyframeAnimation< TValueType >::addKeyframe	(	chrono::milliseconds	timeStamp,
		KeyframePtr	keyframe
	)

inline

Adds a keyframe to given timestamp.

Parameters

timeStamp	Timestamp to add to.
keyframe	Keyframe unique pointer.

◆ getTimestamp()

template<typename TValueType >

chrono::milliseconds kanzi::KeyframeAnimation< TValueType >::getTimestamp ( size_t index )

inline

Returns timestamp by index.

Parameters

index Index.

Returns: Timestamp at index.

◆ getKeyFrameCount()

template<typename TValueType >

size_t kanzi::KeyframeAnimation< TValueType >::getKeyFrameCount ( )

inline

Returns the number of keyframes in this animation.

Returns: The number of keyframes in this animation.

◆ getKeyFrame()

template<typename TValueType >

Keyframe& kanzi::KeyframeAnimation< TValueType >::getKeyFrame ( size_t index )

inline

Returns keyframe by index.

To get an interpolated animation value at a time, use getValue() instead.

Parameters

index Index.

Returns: Keyframe at index.

◆ addStepKeyframe()

template<typename TValueType >

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

inline

◆ addLinearKeyframe()

template<typename TValueType >

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

inline

◆ addBezierKeyframe()

template<typename TValueType >

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

inline

◆ getValue()

template<typename TValueType >

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

inlineoverridevirtual

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

Parameters

currentValue	The current value of the animated property.
time	Time relative since the beginning of the animation.

Returns: The value of the animated property at a given time.

Implements kanzi::ValueAnimation< TValueType >.

◆ getDurationOverride()

template<typename TValueType >

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

inlineoverrideprotectedvirtual

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

◆ KeyframePtr

◆ KeyframeContainer

◆ StepKeyframePtr

◆ LinearKeyframePtr

◆ BezierKeyframePtr

Constructor & Destructor Documentation

◆ KeyframeAnimation()

Member Function Documentation

◆ makeEditorInfo()

◆ create()

◆ addKeyframe()

◆ getTimestamp()

◆ getKeyFrameCount()

◆ getKeyFrame()

◆ addStepKeyframe()

◆ addLinearKeyframe()

◆ addBezierKeyframe()

◆ getValue()

◆ getDurationOverride()

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