Template class for from-to animations. More...

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

Inheritance diagram for kanzi::FromToAnimation< TValueType, TEasingFunction >:

Public Member Functions
TEasingFunction	getEasingFunction () const
	Returns the easing function of the animation. More...

TValueType	getValue (const TValueType &currentValue, chrono::milliseconds time) override
	ValueAnimation::getValue() implementation. More...

void	setEasingFunction (TEasingFunction easingFunction)
	Sets the easing function of the animation. More...

Public Member Functions inherited from kanzi::FromToAnimationBase< TValueType >
AnimationEasingMode	getEasingMode () const
	Returns the easing function of the animation. More...

optional< TValueType >	getFrom () const
	Returns "From" value of the animation. More...

optional< TValueType >	getTo () const
	Returns "To" value of the animation. More...

bool	hasFrom () const
	If the animation has a "From" value, returns true, otherwise false. More...

bool	hasTo () const
	If the animation has a "To" value, returns true, otherwise false. More...

void	setDuration (chrono::milliseconds duration)
	Sets the animation duration. More...

void	setEasingMode (AnimationEasingMode mode)
	Sets the easing function of the animation. More...

void	setFrom (optional< TValueType > from)
	Sets "From" value of the animation. More...

void	setTo (optional< TValueType > to)
	Sets "To" value of the animation. 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< FromToAnimation >	create (Domain *domain, chrono::milliseconds duration, optional< TValueType > from, optional< TValueType > to)
	Creates a from-to animation with the given duration and easing function. More...

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Returns an empty PropertyType editor information. More...

Static Public Member Functions inherited from kanzi::FromToAnimationBase< TValueType >
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Returns an empty PropertyType editor information. More...

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
float	easeTime (float normalizedTime) const
	Returns the eased time of the animation. More...

	FromToAnimation (Domain *domain, chrono::milliseconds duration, optional< TValueType > from, optional< TValueType > to)
	Constructor. More...

Protected Member Functions inherited from kanzi::FromToAnimationBase< TValueType >
	FromToAnimationBase (Domain *domain, chrono::milliseconds duration, optional< TValueType > from, optional< TValueType > to)
	Constructor. More...

optional< chrono::milliseconds >	getDurationOverride () override
	AbstractAnimation::getDurationOverride() implementation. 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
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

Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container. More...

Protected Attributes inherited from kanzi::FromToAnimationBase< TValueType >
chrono::milliseconds	m_duration
	Animation duration. More...

AnimationEasingMode	m_easingMode
	Easing mode. More...

optional< TValueType >	m_from
	"From" value of the animation. More...

optional< TValueType >	m_to
	"To" value of the animation. More...

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

Detailed Description

template<typename TValueType, typename TEasingFunction>
class kanzi::FromToAnimation< TValueType, TEasingFunction >

Template class for from-to animations.

Template Parameters

TValueType	Defines the type of the value you want to animate. For example, float, bool, int, ColorRGBA.
TEasingFunction	Defines the type of the easing function used for the animation. For example, LinearEasingFunction, SmoothStepEasingFunction, BackEasingFunction. For a full list of easing functions

See also: easing_curve_shared.hpp.

Kanzi animation system consists of animations and timelines:

Animations define how to animate a property.
Timelines map the animations to time and the objects you want to animate.

Use from-to animation to define from which -> to which value you want to animate a property. You can omit either of these "from" and "to" values to animate the property using its current value, respectively.

You can define the rate of change of a from-to animation by using an easing curve. You can use one of the easing curves that comes with Kanzi, or define your own. With the easing mode you can control how the easing function is applied to the animation:

Ease in easing mode applies to the transition the easing function as it is.
Ease out easing mode applies to the transition the negative value of the easing function.
Ease in-out easing mode applies to the first half of the transition the easing function as it is, and to the second half of the transition the negative value of the easing function.

Examples

To create a from-to animation:

        // Create a from-to animation that uses the linear easing function and is two seconds long.
        // As a starting value, the animation takes the current value of the property in the node you want to animate.
        // The animation sets the final value of the property in the node you animate to 200.
        // You set which node this animation animates in the timeline.
        FloatLinearFromToAnimationSharedPtr linearAnimation = FloatLinearFromToAnimation::create(domain, chrono::seconds(2), nullopt, 200.0f);

To animate a property value in a node using a from-to animation:

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

To animate a property field value in a node using a from-to 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);
        // Scale the current node on the x axis by animating the Scale X property field of the Render Transformation property
        // with the linearAnimation from-to animation.
        propertyFieldTimeline->addEntry(PropertyFieldScaleX, linearAnimation);

To create a float from-to animation that uses the back easing curve and the ease out easing mode:

        // Define the FloatBackFromToAnimation to use float values and Back easing function.
        typedef FromToAnimation<float, BackEasingFunction> FloatBackFromToAnimation;
        typedef shared_ptr<FloatBackFromToAnimation> FloatBackFromToAnimationSharedPtr;
        // Create a from-to animation that uses the back easing function and is 5000 milliseconds long.
        // The animation sets the starting value of the property in the node you want to animate to 100,
        // and the final value of that property to 300.
        FloatBackFromToAnimationSharedPtr backAnimation = FloatBackFromToAnimation::create(domain, chrono::milliseconds(5000), nullopt, 300.0f);
        // Set the easing mode of the backAnimation from-to animation to Ease out.
        backAnimation->setEasingMode(AnimationEaseOut);

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);

Constructor & Destructor Documentation

◆ FromToAnimation()

template<typename TValueType , typename TEasingFunction >

kanzi::FromToAnimation< TValueType, TEasingFunction >::FromToAnimation	(	Domain *	domain,
		chrono::milliseconds	duration,
		optional< TValueType >	from,
		optional< TValueType >	to
	)

inlineexplicitprotected

Constructor.

Parameters

domain	Domain.
duration	Animation duration in milliseconds.
from	Value from which you want to animate the property, if omitted(that is, set to nullopt), the current value of the property will be used.
to	Value to which you want to animate the property, if omitted(that is, set to nullopt), the current value of the property will be used.

Member Function Documentation

◆ makeEditorInfo()

template<typename TValueType , typename TEasingFunction >

static PropertyTypeEditorInfoSharedPtr kanzi::FromToAnimation< TValueType, TEasingFunction >::makeEditorInfo ( )

inlinestatic

Returns an empty PropertyType editor information.

◆ create()

template<typename TValueType , typename TEasingFunction >

static shared_ptr<FromToAnimation> kanzi::FromToAnimation< TValueType, TEasingFunction >::create	(	Domain *	domain,
		chrono::milliseconds	duration,
		optional< TValueType >	from,
		optional< TValueType >	to
	)

inlinestatic

Creates a from-to animation with the given duration and easing function.

Parameters

domain	Domain.
duration	Animation duration in milliseconds.
from	Value from which you want to animate the property, if omitted(that is, set to nullopt), the current value of the property will be used.
to	Value to which you want to animate the property, if omitted(that is, set to nullopt), the current value of the property will be used.

Returns: The created animation.

◆ getEasingFunction()

template<typename TValueType , typename TEasingFunction >

TEasingFunction kanzi::FromToAnimation< TValueType, TEasingFunction >::getEasingFunction ( ) const

inline

Returns the easing function of the animation.

Returns: Easing function of the animation.

◆ setEasingFunction()

template<typename TValueType , typename TEasingFunction >

void kanzi::FromToAnimation< TValueType, TEasingFunction >::setEasingFunction ( TEasingFunction easingFunction )

inline

Sets the easing function of the animation.

Parameters

easingFunction The easing function of the animation.

◆ getValue()

template<typename TValueType , typename TEasingFunction >

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

inlineoverridevirtual

ValueAnimation::getValue() implementation.

Implements kanzi::ValueAnimation< TValueType >.

◆ easeTime()

template<typename TValueType , typename TEasingFunction >

float kanzi::FromToAnimation< TValueType, TEasingFunction >::easeTime ( float normalizedTime ) const

inlineprotected

Returns the eased time of the animation.

Parameters

normalizedTime Normalized current time.

Returns: Eased time of the animation.

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

kanzi/core.ui/animation/from_to_animation.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

template<typename TValueType, typename TEasingFunction> class kanzi::FromToAnimation< TValueType, TEasingFunction >

Examples

Constructor & Destructor Documentation

◆ FromToAnimation()

Member Function Documentation

◆ makeEditorInfo()

◆ create()

◆ getEasingFunction()

◆ setEasingFunction()

◆ getValue()

◆ easeTime()

template<typename TValueType, typename TEasingFunction>
class kanzi::FromToAnimation< TValueType, TEasingFunction >