kanzi::TimelinePlayback Class Referenceabstract

Playback object for Timelines. More...

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

Inheritance diagram for kanzi::TimelinePlayback:
kanzi::Object kanzi::MetaObject kanzi::PropertyObject kanzi::MorphWeightTimelinePlayback kanzi::ParallelTimelinePlayback kanzi::PreviewTimelinePlayback kanzi::PropertyAnimationTimelinePlayback kanzi::PropertyFieldAnimationTimelinePlayback kanzi::PropertyFieldTargetInterpolationTimelinePlayback kanzi::PropertyTargetInterpolationTimelinePlayback

Public Types

enum  State { StateNotStarted, StateOngoing, StateCompleted, StateStopped }
 Status of the playback. More...
 
typedef function< void(TimelinePlayback &)> CompleteCallback
 Callback for complete timeline. More...
 
- Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStoragePropertyStoragePtr
 
typedef vector< PropertyStoragePtrPropertyStorageContainer
 
typedef PropertyStorageContainer::iterator PropertyStorageIterator
 
typedef PropertyStorageContainer::const_iterator PropertyStorageConstIterator
 
typedef PropertyStorageContainer::reverse_iterator PropertyStorageReverseIterator
 

Public Member Functions

 TimelinePlayback (Domain *domain, TimelineSharedPtr timeline)
 Constructor. More...
 
virtual ~TimelinePlayback ()
 Destructor. More...
 
void setParent (TimelinePlayback *playback)
 Sets parent playback. More...
 
void setCompleteCallback (CompleteCallback callback)
 Sets complete callback. More...
 
State getState () const
 Gets current state of playback. More...
 
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. More...
 
chrono::milliseconds getGlobalTime () const
 Gets current global time of TimelinePlayback. More...
 
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. More...
 
chrono::milliseconds getProgressTime () const
 Gets current progress time of TimelinePlayback. More...
 
bool isApplied () const
 Indicates whether TimelinePlayback is applied. More...
 
void onParentAppliedStateChanged ()
 Notifies TimelinePlayback whether the applied state of its parent playback has changed. More...
 
void onParentCompleted ()
 Notifies TimelinePlayback whether its parent playback has completed. More...
 
void stop ()
 Stops playback. More...
 
- Public Member Functions inherited from kanzi::Object
 Object (Domain *domain)
 
virtual ~Object ()
 
DomaingetDomain () const
 Returns the domain the object belongs to. More...
 
KzuTaskSchedulergetTaskScheduler () const
 Returns the task scheduler of the object. More...
 
KzuMessageDispatchergetMessageDispatcher () const
 Returns the message dispatcher of the object. More...
 
ResourceManagergetResourceManager () const
 Returns the resource manager of the object. More...
 
virtual const MetaclassgetDynamicMetaclass () const KZ_OVERRIDE
 Returns the metaclass of the dynamic type of the object. More...
 
AppliedStyleEntryapplyObjectStyle (kanzi::StyleSharedPtr style)
 Applies a style to an object. More...
 
void unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry)
 
void applyObjectStyles ()
 Apply all styles for an object node. More...
 
void unapplyObjectStyles ()
 Unapplies and removes all applied styles. More...
 
- Public Member Functions inherited from kanzi::MetaObject
virtual ~MetaObject ()
 
bool isTypeOf (const Metaclass *objectType) const
 Determines if the type of this object is the given type or derived from it. More...
 
- Public Member Functions inherited from kanzi::PropertyObject
 PropertyObject ()
 
virtual ~PropertyObject ()
 
template<typename DataType >
void setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 Sets the local value of a property. More...
 
void removeKzbProperties ()
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getProperty (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property. More...
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalProperty (const PropertyType< DataType > &propertyType) const
 Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More...
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getPropertyBase (const PropertyType< DataType > &propertyType) const
 Returns the current value of a property disregarding modifiers. More...
 
template<typename DataType >
void setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
PropertyType< DataType >::Traits::ReturnType getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const
 
template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType > getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const
 
void setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const
 
void clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)
 
bool hasValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value. More...
 
bool hasBaseValue (AbstractPropertyType propertyType) const
 Evaluates whether there are any inputs into the property value, disregarding modifiers. More...
 
bool hasLocalValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a local value set for the property. More...
 
bool hasNonClassValue (AbstractPropertyType propertyType) const
 Evaluates whether there is a value of any precedence higher than class default value set for the property. More...
 
void removeLocalValue (AbstractPropertyType propertyType)
 Removes the local value associated with the property. More...
 
void copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
 Copies local value of single property from another object. More...
 
void copyLocalValues (const PropertyObject &other)
 Copies all local values from another object. More...
 
virtual void onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
 Virtual function to handle property change notifications. More...
 
template<typename DataType >
void addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
template<typename DataType >
void removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *owner)
 
template<typename DataType >
void addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
template<typename DataType >
void removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
 
void validatePropertyModifiers (AbstractPropertyType propertyType)
 
template<typename DataType >
void addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
void removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)
 
template<typename DataType >
size_t getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType)
 Gets number of current notification handlers for given property type. More...
 

Protected Member Functions

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. More...
 
virtual void onProgressTimeResetOverride ()
 TimelinePlayback calls this function after its progress time has been reset to a new value. More...
 
virtual void onAppliedStateChangedOverride ()
 TimelinePlayback calls this function after its applied state has changed. More...
 
virtual void onPlaybackCompletedOverride ()
 TimelinePlayback calls this function after it has become complete. More...
 
void notifyPlaybackCompleted ()
 Calls completion callback if it is available. More...
 
- Protected Member Functions inherited from kanzi::Object
void initialize ()
 
void onCopy (const Object &other)
 
- Protected Member Functions inherited from kanzi::MetaObject
 MetaObject ()
 
void initialize ()
 
- Protected Member Functions inherited from kanzi::PropertyObject
void addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *owner)
 
void removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner)
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntrygetTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourcegetClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
 
AbstractPropertyTypeDescriptor::ValueSourceEntryfindLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryconstructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 
AbstractPropertyTypeDescriptor::ValueSourceEntryacquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::PropertyStoragefindPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
 
PropertyStoragePtr findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
 Gets property storage intrusive pointer that can be used to hold a reference until end of operation. More...
 
PropertyStoragePtr constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
PropertyStoragePtr acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStorageacquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::ModifierStoragefindModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStorageacquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptor::NotificationStoragefindNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
 
AbstractPropertyTypeDescriptorfindPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType)
 
void validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
 
void copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
 Copy local value from property storage. More...
 
PropertyStorageContainer::iterator beginPropertyStorage ()
 
PropertyStorageContainer::iterator endPropertyStorage ()
 
virtual void notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason)
 
void onCopy (const PropertyObject &other)
 

Additional Inherited Members

- Static Public Member Functions inherited from kanzi::Object
static const MetaclassgetStaticMetaclass ()
 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 MetaclassgetStaticMetaclass ()
 Returns the metaclass of Object class. More...
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 Default implementation that returns empty editor info. More...
 
- Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntry * > AppliedStyleContainer
 Applied style container. More...
 
- Protected Attributes inherited from kanzi::Object
AppliedStyleContainer m_appliedStyles
 Listing of applied styles applied to this object. More...
 

Detailed Description

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

Callback for complete timeline.

Member Enumeration Documentation

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

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

Constructor.

Parameters
domainDomain.
timelineTimeline to perform playback on.
virtual kanzi::TimelinePlayback::~TimelinePlayback ( )
virtual

Destructor.

Member Function Documentation

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
playbackParent playback.
void kanzi::TimelinePlayback::setCompleteCallback ( CompleteCallback  callback)

Sets complete callback.

Parameters
callbackwhich is called when playback is complete.
State kanzi::TimelinePlayback::getState ( ) const

Gets current state of playback.

Returns
Playback status.
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
deltaTimeDelta time of Playback's global time since last tick.
chrono::milliseconds kanzi::TimelinePlayback::getGlobalTime ( ) const

Gets current global time of TimelinePlayback.

Returns
Global time of playback.
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
timeGlobal time of playback.
chrono::milliseconds kanzi::TimelinePlayback::getProgressTime ( ) const

Gets current progress time of TimelinePlayback.

Returns
Progress time.
bool kanzi::TimelinePlayback::isApplied ( ) const

Indicates whether TimelinePlayback is applied.

Returns
true if TimelinePlayback is applied, false otherwise.
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.

void kanzi::TimelinePlayback::onParentCompleted ( )

Notifies TimelinePlayback whether its parent playback has completed.

This function should only be called by parent playback.

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.

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
deltaTimeDelta time. It can be positive as well as negative.

Implemented in kanzi::PropertyAnimationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, kanzi::PropertyTargetInterpolationTimelinePlayback, kanzi::PropertyFieldTargetInterpolationTimelinePlayback, kanzi::PreviewTimelinePlayback, kanzi::MorphWeightTimelinePlayback, and kanzi::ParallelTimelinePlayback.

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::PropertyAnimationTimelinePlayback, kanzi::PropertyTargetInterpolationTimelinePlayback, kanzi::PropertyFieldTargetInterpolationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, kanzi::PreviewTimelinePlayback, kanzi::MorphWeightTimelinePlayback, and kanzi::ParallelTimelinePlayback.

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::PropertyAnimationTimelinePlayback, kanzi::PropertyTargetInterpolationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, and kanzi::ParallelTimelinePlayback.

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.

void kanzi::TimelinePlayback::notifyPlaybackCompleted ( )
protected

Calls completion callback if it is available.


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