The Kanzi animation system consists of animations, which define how to animate properties, and timelines, which map animations to time and to the objects that you want to animate. More...

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

Inheritance diagram for kanzi::PropertyAnimationTimeline:

[legend]

Public Member Functions
optional< chrono::milliseconds >	calculateContentDuration () override
	Timeline::calculateContentDuration() implementation. More...

AbstractAnimationSharedPtr	getAnimation () const
	Gets the animation that is applied to the target property. More...

AbstractPropertyType	getPropertyType () const
	Gets the target property type to which the timeline animation is applied. More...

	~PropertyAnimationTimeline () override
	Destructor. More...

Public Member Functions inherited from kanzi::Timeline
TimeInterval	calculateClipInterval ()
	Calculates clip interval of timeline. More...

optional< chrono::milliseconds >	calculateDuration ()
	Calculates the duration of the timeline. More...

unsigned int	calculateIterationCount ()
	Calculates number of iterations in timeline. More...

optional< chrono::milliseconds >	calculateIterationDuration ()
	Calculates iteration duration. More...

TimelinePlaybackSharedPtr	createPlayback (TimelinePlaybackContext &context)
	Creates playback for timeline. More...

optional< chrono::milliseconds >	getClipDuration () const
	Gets the clip duration of the timeline (in milliseconds). More...

chrono::milliseconds	getClipStartTime () const
	Gets the clip start time of the timeline (in milliseconds). More...

DirectionBehavior	getDirectionBehavior () const
	Gets the direction behavior of a timeline. More...

float	getDurationScale () const
	Gets the duration scale of timeline. More...

float	getMinimumDurationScale () const
	Gets minimum duration scale. More...

unsigned int	getRepeatCount () const
	Gets the repeat count of the timeline (zero indicates infinite repeats). More...

chrono::milliseconds	getStartTime () const
	Gets the start time of the timeline (in milliseconds). More...

void	setClipDuration (optional< chrono::milliseconds > duration)
	Sets the clip duration of the timeline (in milliseconds). More...

void	setClipStartTime (chrono::milliseconds clipStartTime)
	Sets the clip start time of the timeline (in milliseconds). More...

void	setDirectionBehavior (DirectionBehavior directionBehavior)
	Sets the direction behavior of a timeline. More...

void	setDurationScale (float scale)
	Sets the duration scale of timeline. More...

void	setRepeatCount (unsigned int repeatCount)
	Sets the repeat count of the timeline (zero indicates infinite repeats). More...

void	setStartTime (chrono::milliseconds startTime)
	Gets the start time of the timeline (in milliseconds). 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 TimelineSharedPtr	create (Domain *domain, string_view name)
	Creates new PropertyAnimationTimeline instance and returns it. More...

template<typename TPropertyDataType , typename TAnimationDataType >
static PropertyAnimationTimelineSharedPtr	create (Domain *domain, string_view objectPath, const PropertyType< TPropertyDataType > &propertyType, shared_ptr< ValueAnimation< TAnimationDataType > > animation)
	Creates a PropertyAnimationTimeline instance and returns it. More...

static PropertyAnimationTimelineSharedPtr	create (Domain *domain, string_view objectPath, AbstractPropertyType propertyType, AbstractAnimationSharedPtr animation)
	Creates a PropertyAnimationTimeline instance and returns it. More...

static ObjectSharedPtr	load (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads a timeline from a kzb file. 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
TimelinePlaybackSharedPtr	createPlaybackOverride (TimelinePlaybackContext &context) override
	Timeline::createPlaybackOverride() implementation. More...

void	loadOverride (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser) override
	Timeline::loadOverride() implementation. More...

	PropertyAnimationTimeline (Domain *domain)
	Constructor. More...

	PropertyAnimationTimeline (Domain *domain, string_view objectPath, AbstractPropertyType propertyType, AbstractAnimationSharedPtr animation)
	Constructor. More...

Protected Member Functions inherited from kanzi::Timeline
	Timeline (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 &propertyStorage, PropertyNotificationReason reason)

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)

Friends
class	PropertyAnimationTimelinePlayback

Additional Inherited Members
Public Types inherited from kanzi::Timeline
enum	DirectionBehavior { DirectionBehaviorNormal, DirectionBehaviorReverse, DirectionBehaviorPingPong }
	Specifies the direction behavior for a timeline. More...

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::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object. More...

Detailed Description

The Kanzi animation system consists of animations, which define how to animate properties, and timelines, which map animations to time and to the objects that you want to animate.

Property timeline applies an animation to a property of an object. For example, to change the layout size of an Image2D node, use the property timeline to animate the Node::WidthProperty and Node::HeightProperty properties of that node.

Examples

To create a property timeline:

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

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

◆ ~PropertyAnimationTimeline()

kanzi::PropertyAnimationTimeline::~PropertyAnimationTimeline ( )

override

Destructor.

◆ PropertyAnimationTimeline() [1/2]

kanzi::PropertyAnimationTimeline::PropertyAnimationTimeline ( Domain * domain )

explicitprotected

Constructor.

Parameters

domain Domain.

◆ PropertyAnimationTimeline() [2/2]

kanzi::PropertyAnimationTimeline::PropertyAnimationTimeline	(	Domain *	domain,
		string_view	objectPath,
		AbstractPropertyType	propertyType,
		AbstractAnimationSharedPtr	animation
	)

explicitprotected

Constructor.

Parameters

domain	Domain.
objectPath	Relative path to the object to which to apply the timeline. This path is resolved when creating the playback from the timeline.
propertyType	The property type to which to apply the timeline animation.
animation	The animation to apply to the target property.

Member Function Documentation

◆ create() [1/3]

static TimelineSharedPtr kanzi::PropertyAnimationTimeline::create	(	Domain *	domain,
		string_view	name
	)

static

Creates new PropertyAnimationTimeline instance and returns it.

Parameters

domain	Domain.
name	Name of PropertyAnimationTimeline.

Returns: New PropertyAnimationTimeline instance.

◆ create() [2/3]

template<typename TPropertyDataType , typename TAnimationDataType >

static PropertyAnimationTimelineSharedPtr kanzi::PropertyAnimationTimeline::create	(	Domain *	domain,
		string_view	objectPath,
		const PropertyType< TPropertyDataType > &	propertyType,
		shared_ptr< ValueAnimation< TAnimationDataType > >	animation
	)

inlinestatic

Creates a PropertyAnimationTimeline instance and returns it.

Parameters

domain	Domain.
objectPath	Relative path to the node to which to apply the timeline. This path is resolved when creating the playback from the timeline.
propertyType	The property type to which to apply the timeline animation.
animation	The animation to apply to the target property.

Returns: New PropertyAnimationTimeline instance.

Exceptions

invalid_argument if the data types of the target property and animation are not compatible.

◆ create() [3/3]

static PropertyAnimationTimelineSharedPtr kanzi::PropertyAnimationTimeline::create	(	Domain *	domain,
		string_view	objectPath,
		AbstractPropertyType	propertyType,
		AbstractAnimationSharedPtr	animation
	)

static

Creates a PropertyAnimationTimeline instance and returns it.

Parameters

domain	Domain.
objectPath	Relative path to the object to which to apply the timeline. This path is resolved when creating the playback from the timeline.
propertyType	The property type to which to apply the timeline animation.
animation	The animation to apply to the target property.

Returns: New PropertyAnimationTimeline instance.

Exceptions

invalid_argument if the data types of the target property and animation are not compatible.

◆ getPropertyType()

AbstractPropertyType kanzi::PropertyAnimationTimeline::getPropertyType ( ) const

Gets the target property type to which the timeline animation is applied.

Returns: Target property.

◆ getAnimation()

AbstractAnimationSharedPtr kanzi::PropertyAnimationTimeline::getAnimation ( ) const

Gets the animation that is applied to the target property.

Returns: Animation.

◆ calculateContentDuration()

optional<chrono::milliseconds> kanzi::PropertyAnimationTimeline::calculateContentDuration ( )

overridevirtual

Timeline::calculateContentDuration() implementation.

Reimplemented from kanzi::Timeline.

◆ load()

static ObjectSharedPtr kanzi::PropertyAnimationTimeline::load	(	Domain *	domain,
		string_view	name,
		KzbFile &	kzbFile,
		KzbMemoryParser &	parser
	)

static

Loads a timeline from a kzb file.

Parameters

domain	Domain.
name	The name of the timeline.
kzbFile	The kzb file from which to load the timeline data.
parser	The parser for parsing the timeline data.

Returns: Loaded timeline.

◆ createPlaybackOverride()

TimelinePlaybackSharedPtr kanzi::PropertyAnimationTimeline::createPlaybackOverride ( TimelinePlaybackContext & context )

overrideprotectedvirtual

Timeline::createPlaybackOverride() implementation.

Implements kanzi::Timeline.

◆ loadOverride()

void kanzi::PropertyAnimationTimeline::loadOverride	(	Domain *	domain,
		string_view	name,
		KzbFile &	kzbFile,
		KzbMemoryParser &	parser
	)

overrideprotectedvirtual

Timeline::loadOverride() implementation.

Reimplemented from kanzi::Timeline.

Friends And Related Function Documentation

◆ PropertyAnimationTimelinePlayback

friend class PropertyAnimationTimelinePlayback

friend

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

kanzi/core.ui/animation/property_animation_timeline.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Examples

Constructor & Destructor Documentation

◆ ~PropertyAnimationTimeline()

◆ PropertyAnimationTimeline() [1/2]

◆ PropertyAnimationTimeline() [2/2]

Member Function Documentation

◆ create() [1/3]

◆ create() [2/3]

◆ create() [3/3]

◆ getPropertyType()

◆ getAnimation()

◆ calculateContentDuration()

◆ load()

◆ createPlaybackOverride()

◆ loadOverride()

Friends And Related Function Documentation

◆ PropertyAnimationTimelinePlayback