Playback object for Timelines. More...

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

Inheritance diagram for kanzi::TimelinePlayback:

Public Types
typedef function< void(TimelinePlayback &)	CompleteCallback)
	Callback for complete timeline.

enum	State { StateNotStarted , StateOngoing , StateCompleted , StateStopped }
	Status of the playback. 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

Public Member Functions
chrono::milliseconds	getGlobalTime () const
	Gets current global time of TimelinePlayback.

chrono::milliseconds	getProgressTime () const
	Gets current progress time of TimelinePlayback.

State	getState () const
	Gets current state of playback.

bool	isApplied () const
	Indicates whether TimelinePlayback is applied.

void	onParentAppliedStateChanged ()
	Notifies TimelinePlayback whether the applied state of its parent playback has changed.

void	onParentCompleted ()
	Notifies TimelinePlayback whether its parent playback has completed.

void	setCompleteCallback (CompleteCallback callback)
	Sets complete callback.

void	setGlobalTime (chrono::milliseconds time)
	Sets global time of playback and calculates new global time from it as well as other parameters such as current iteration index, etc.

void	setParent (TimelinePlayback *playback)
	Sets parent playback.

void	stop ()
	Stops playback.

void	tick (chrono::milliseconds deltaTime)
	Advances TimelinePlayback's global time by delta time and calculates new progress time from it as well as other parameters such as current iteration index, etc.

	TimelinePlayback (Domain *domain, TimelineSharedPtr timeline)
	Constructor.

	~TimelinePlayback () override
	Destructor.

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

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

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

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

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

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

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

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

	Object (Domain *domain)

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

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

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

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	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

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, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

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

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

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

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

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

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

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

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

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.

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.

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

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

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

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

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

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

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

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

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

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

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

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.

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.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Protected Member Functions
void	notifyPlaybackCompleted ()
	Calls completion callback if it is available.

virtual void	onAppliedStateChangedOverride ()
	TimelinePlayback calls this function after its applied state has changed.

virtual void	onPlaybackCompletedOverride ()
	TimelinePlayback calls this function after it has become complete.

virtual void	onProgressTimeResetOverride ()
	TimelinePlayback calls this function after its progress time has been reset to a new value.

virtual void	tickOverride (chrono::milliseconds deltaTime)=0
	TimelinePlayback calls this function after its progress time has gradually changed from its old value to new one.

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.

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

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

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

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

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

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

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

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.

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

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

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

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

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.

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

void	onCopy (const PropertyObject &other)

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

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

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

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

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

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

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

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

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

Detailed Description

Playback object for Timelines.

TimelinePlayback keeps track of how timeline is played.

To perform playback of Timeline, create a TimelinePlayback object by calling the Timeline::createPlayback() function of Timeline. After that you add playback to a TimelineClock by calling its TimelineClock::addTimelinePlayback() function. TimelineClock will advance the global time of TimelinePlayback object which in turn will advance Timeline.

Playback is associated with its timeline during its complete lifetime. It is possible to create multiple playbacks from a single timeline. Each playback of timeline has its own track of how timeline is played at current point in time:

        // Create first playback for timeline and add it to the clock.
        SceneGraphTimelinePlaybackContext firstPlaybackContext(*firstNodeToAnimate);
        TimelinePlaybackSharedPtr firstPlayback = timeline->createPlayback(firstPlaybackContext);
        timelineClock->addTimelinePlayback(firstPlayback);
 
        // Create second playback for timeline and add it to the clock.
        SceneGraphTimelinePlaybackContext secondPlaybackContext(*secondNodeToAnimate);
        TimelinePlaybackSharedPtr secondPlayback = timeline->createPlayback(secondPlaybackContext);
        timelineClock->addTimelinePlayback(secondPlayback);

Once playback of timeline starts playing timeline, none of timeline properties should be changed.

Global time

After TimelinePlayback is added to a clock, the clock applies it by periodically calling its tick() function. Delta time argument of this function is interpreted by TimelinePlayback as change in its global time. Timeline start time and duration are defined in global time space. Playback calculates all its parameters from global time: current iteration index, progress time inside the iteration, whether it is applied and so on. Before playback is added to a clock, its global time is undefined.

To manually set global time of TimelinePlayback call its setGlobalTime() function:

// Set global time of timeline playback to 10 milliseconds.

timelinePlayback->setGlobalTime(chrono::milliseconds(20));

To retrieve global time of TimelinePlayback call its getGlobalTime() function:

// Get global time of timeline playback.

chrono::milliseconds globalTime = timelinePlayback->getGlobalTime();

Note that setting global time of TimelinePlayback which has parent TimelinePlayback can result in undefined behavior.

Progress time

When global time is changing, TimelinePlayback calculates progress time from it. Progress time is defined in Timeline's progress time space and it is the time at which the progress of timeline is applied. TimelinePlayback notifies its subclasses every time it calculates its progress time from global time. TimelinePlayback can notify its subclasses about gradual change in progress time or about reset of progress time. When TimelinePlayback notifies its subclasses that progress time has changed gradually, they advance their timelines gradually from previous progress time value to the new one. When TimelinePlayback notifies its subclasses that progress time has been reset to a new value they reset their animations to new progress time. Before playback is added to a clock, its progress time is undefined. After playback is added to a clock, its progress time is always within timeline progress interval.

To retrieve the progress time of TimelinePlayback call its getProgressTime() function:

// Get progress time of timeline playback.

chrono::milliseconds progressTime = timelinePlayback->getProgressTime();

Applied state

Depending on global time TimelinePlayback can decide whether its timeline should be applied or not. TimelinePlayback is not applied (that is, its timeline is not applied) if its global time goes before timeline start time or if TimelinePlayback's parent playback is not applied. In all other cases TimelinePlayback is applied, even if its global time advances past timeline duration interval. When TimelinePlayback changes from applied to not applied (or the other way around) it notifies its subclasses so they start or stop applying their Timelines. If TimelinePlayback with child TimelinePlaybacks changes its applied state, this change propagates down the hierarchy of playbacks. For example, if parent TimelinePlayback becomes not applied, then its child playbacks also become not applied even though they have their global times inside Timeline duration interval.

After the global time of TimelinePlayback has come to an end of its Timeline duration and it is still advancing beyond the end of Timeline duration, then TimelinePlayback is still applied. In this case TimelinePlayback clamps the progress time of timeline to the last valid value inside Timeline's progress interval and keeps applying the Timeline.

To retrieve the applied state of TimelinePlayback call its isApplied() function:

// Get applied state of timeline playback.

bool isPlaybackActive = timelinePlayback->isApplied();

Completion

At some point every TimelinePlayback can become complete. Root TimelinePlayback becomes complete when its total time goes past its timeline duration. In this case TimelinePlayback propagates completion down the tree of child playbacks so each of them can notify that it is complete. It means that child TimelinePlayback is complete only when its root playback is complete. However, even though TimelinePlayback has notified about its completion, it continues to apply its Timeline. TimelinePlayback stops applying its timeline only after it is destroyed.

Member Typedef Documentation

◆ CompleteCallback

typedef function<void(TimelinePlayback&) kanzi::TimelinePlayback::CompleteCallback)

Callback for complete timeline.

Member Enumeration Documentation

◆ State

enum kanzi::TimelinePlayback::State

Status of the playback.

Enumerator
StateNotStarted	Playback has not started: playback's global time goes before the Timeline's start time.
StateOngoing	Playback is progressing: playback's global time is within Timeline duration interval.
StateCompleted	Whole timeline has completed: playback's global time goes after Timeline's end.
StateStopped	Playback of timeline has stopped. Stopped playback could not be resumed.

Constructor & Destructor Documentation

◆ TimelinePlayback()

kanzi::TimelinePlayback::TimelinePlayback	(	Domain *	domain,
		TimelineSharedPtr	timeline )

explicit

Constructor.

Parameters

domain	Domain.
timeline	Timeline to perform playback on.

◆ ~TimelinePlayback()

kanzi::TimelinePlayback::~TimelinePlayback ( )

override

Destructor.

Member Function Documentation

◆ setParent()

void kanzi::TimelinePlayback::setParent ( TimelinePlayback * playback )

Sets parent playback.

This function should only be called before this playback or parent playback are added to the clock.

Parameters

playback Parent playback.

◆ setCompleteCallback()

void kanzi::TimelinePlayback::setCompleteCallback ( CompleteCallback callback )

Sets complete callback.

Parameters

callback which is called when playback is complete.

◆ getState()

State kanzi::TimelinePlayback::getState ( ) const

Gets current state of playback.

Returns: Playback status.

◆ tick()

void kanzi::TimelinePlayback::tick ( chrono::milliseconds deltaTime )

Advances TimelinePlayback's global time by delta time and calculates new progress time from it as well as other parameters such as current iteration index, etc.

During the call to this function TimelinePlayback can call its tickOverride() and onProgressTimeResetOverride() functions multiple times. Also TimelinePlayback can become complete during the call to this function (and onPlaybackCompletedOverride() function called) or its applied state can change (and onAppliedStateChangedOverride() function called).

Parameters

deltaTime Delta time of Playback's global time since last tick.

◆ getGlobalTime()

chrono::milliseconds kanzi::TimelinePlayback::getGlobalTime ( ) const

Gets current global time of TimelinePlayback.

Returns: Global time of playback.

◆ setGlobalTime()

void kanzi::TimelinePlayback::setGlobalTime ( chrono::milliseconds time )

Sets global time of playback and calculates new global time from it as well as other parameters such as current iteration index, etc.

During the call to this function Playback will call its onProgressTimeResetOverride() function. Also Playback can become complete during the call to this function (and onPlaybackCompletedOverride() function called) or its applied state can change (and onAppliedStateChangedOverride() function called).

Parameters

time	Global time of playback.

◆ getProgressTime()

chrono::milliseconds kanzi::TimelinePlayback::getProgressTime ( ) const

Gets current progress time of TimelinePlayback.

Returns: Progress time.

◆ isApplied()

bool kanzi::TimelinePlayback::isApplied ( ) const

Indicates whether TimelinePlayback is applied.

Returns: true if TimelinePlayback is applied, false otherwise.

◆ onParentAppliedStateChanged()

void kanzi::TimelinePlayback::onParentAppliedStateChanged ( )

Notifies TimelinePlayback whether the applied state of its parent playback has changed.

This function should only be called by parent playback.

◆ onParentCompleted()

void kanzi::TimelinePlayback::onParentCompleted ( )

Notifies TimelinePlayback whether its parent playback has completed.

This function should only be called by parent playback.

◆ stop()

void kanzi::TimelinePlayback::stop ( )

Stops playback.

Stopped playback does not animate any properties and subsequent calls to its tick() and setGlobalTime() methods does not have any effect. Once playback has stopped, it is not possible to resume it again. It is allowed to stop playback by calling this method in completion callback of playback. Global time and local time of stopped playback are undefined.

◆ tickOverride()

virtual void kanzi::TimelinePlayback::tickOverride ( chrono::milliseconds deltaTime )

protectedpure virtual

TimelinePlayback calls this function after its progress time has gradually changed from its old value to new one.

Subclasses of Playback should gradually advance their animations from old progress time to new one during call to this function.

Parameters

deltaTime Delta time. It can be positive as well as negative.

Implemented in kanzi::MorphWeightTimelinePlayback, kanzi::ParallelTimelinePlayback, kanzi::PreviewTimelinePlayback, kanzi::PropertyAnimationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, kanzi::PropertyFieldTargetInterpolationTimelinePlayback, kanzi::PropertyTargetEasingTimelinePlayback, kanzi::PropertyTargetInterpolationTimelinePlayback, and kanzi::ValueAccumulatorTimelinePlayback< TAccumulatedValue >.

◆ onProgressTimeResetOverride()

virtual void kanzi::TimelinePlayback::onProgressTimeResetOverride ( )

protectedvirtual

TimelinePlayback calls this function after its progress time has been reset to a new value.

Subclasses of TimelinePlayback should reset their animations to new time during call to this function; it is not necessary to gradually advance animations from old progress time to new one. This function does nothing by default.

Reimplemented in kanzi::MorphWeightTimelinePlayback, kanzi::ParallelTimelinePlayback, kanzi::PreviewTimelinePlayback, kanzi::PropertyAnimationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, kanzi::PropertyFieldTargetInterpolationTimelinePlayback, kanzi::PropertyTargetEasingTimelinePlayback, kanzi::PropertyTargetInterpolationTimelinePlayback, and kanzi::ValueAccumulatorTimelinePlayback< TAccumulatedValue >.

◆ onAppliedStateChangedOverride()

virtual void kanzi::TimelinePlayback::onAppliedStateChangedOverride ( )

protectedvirtual

TimelinePlayback calls this function after its applied state has changed.

Subclasses of TimelinePlayback should stop applying their animations on target properties if TimelinePlayback has become not applied or start applying animations if TimelinePlayback has become applied. This function does nothing by default.

Reimplemented in kanzi::ParallelTimelinePlayback, kanzi::PropertyAnimationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, kanzi::PropertyTargetEasingTimelinePlayback, kanzi::PropertyTargetInterpolationTimelinePlayback, and kanzi::ValueAccumulatorTimelinePlayback< TAccumulatedValue >.

◆ onPlaybackCompletedOverride()

virtual void kanzi::TimelinePlayback::onPlaybackCompletedOverride ( )

protectedvirtual

TimelinePlayback calls this function after it has become complete.

This function does nothing by default.

Reimplemented in kanzi::ParallelTimelinePlayback.

◆ notifyPlaybackCompleted()

void kanzi::TimelinePlayback::notifyPlaybackCompleted ( )

protected

Calls completion callback if it is available.

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

kanzi/core.ui/animation/timeline_playback.hpp

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Global time

Progress time

Applied state

Completion

Member Typedef Documentation

◆ CompleteCallback

Member Enumeration Documentation

◆ State

Constructor & Destructor Documentation

◆ TimelinePlayback()

◆ ~TimelinePlayback()

Member Function Documentation

◆ setParent()

◆ setCompleteCallback()

◆ getState()

◆ tick()

◆ getGlobalTime()

◆ setGlobalTime()

◆ getProgressTime()

◆ isApplied()

◆ onParentAppliedStateChanged()

◆ onParentCompleted()

◆ stop()

◆ tickOverride()

◆ onProgressTimeResetOverride()

◆ onAppliedStateChangedOverride()

◆ onPlaybackCompletedOverride()

◆ notifyPlaybackCompleted()