The Kanzi animation system consists of animations and timelines: animations define how the values of specific type change in time, and timelines map the animations to properties of objects you want to animate. More...
#include <kanzi/core.ui/animation/timeline.hpp>
Public Types | |
| 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 |
Public Member Functions | |
| 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 | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| Adds a property modifier without notifying handlers. More... | |
| 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) |
| KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. More... | |
| void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
| Validates property modifiers and notifies handlers. More... | |
| virtual | ~PropertyObject () |
Friends | |
| class | TimelinePlayback |
Additional Inherited Members | |
| 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 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... | |
The Kanzi animation system consists of animations and timelines: animations define how the values of specific type change in time, and timelines map the animations to properties of objects you want to animate.
The Timeline class defines common properties which specify how the playback of a timeline is performed. These properties include timeline start time, content clip start time and clip duration, repeat count and so on. Actual classes inherited from the Timeline class define how animations are applied to the properties of objects. For an example of actual classes see PropertyAnimationTimeline, PropertyFieldAnimationTimeline or ParallelTimeline.
Timeline is a series of iterations played successively starting from specified start time. Each iteration is a continuous portion of timeline content which is played in a specific manner. Timeline content can be a single animation (as in PropertyAnimationTimeline), several animations which are animating fields of a single property (as in PropertyFieldAnimationTimeline) or even other timelines (as in ParallelTimeline).
To specify the time at which the first iteration of a timeline starts to play, set the start time property of the timeline. Start time is defined in the time space of the clock where the playback of this timeline is added or in the time space of its parent playback. Start time can be positive or negative. Negative start time causes the timeline to act like it started at some time in the past. It can cause the timeline to start as if it was half-way finished. The default value for start time is 0 milliseconds.
To set the start time of Timeline call its setStartTime() function:
To retrieve the start time of Timeline call its getStartTime() function.
To specify the portion of timeline content played in an iteration set the clip start time and clip duration properties of the timeline. Clip start time and clip duration are defined in the time space of the timeline content. By default, the whole timeline content is played in a single iteration.
To set the clip start time and clip duration of Timeline call its setClipStartTime() and setClipDuration() functions:
To retrieve the clip start time and clip duration of Timeline call its getClipStartTime() and getClipDuration() functions. Note that getClipDuration() can return empty optional, meaning that clip duration is not specified.
To scale the portion of timeline content played in an iteration up or down, set the duration scale property of the timeline. By default, the value of duration scale is 1 which means that timeline content is not scaled. If duration scale is larger than 1, timeline content is scaled up when it is played in an iteration. For example, if you set duration scale to 2, timeline content is played at half speed and the duration of the iteration is twice as long as normally. If duration scale is less than 1, timeline content is scaled down when it is played. For example, if you set duration scale to 0.5, timeline content is played twice as fast as normally and iteration duration is half of the normal. Timeline duration scale cannot be negative or zero. If you set the duration scale to such a value, the timeline will clamp it to the minimum allowed scale value. Timeline duration scale does not affect the start time of the timeline.
To set the duration scale of Timeline call its setDurationScale() function:
To retrieve the duration scale of Timeline call its getDurationScale() function.
Timeline content in an iteration can be played in either normal or reverse direction. By default (or if you set the direction behavior property of the timeline to Timeline::DirectionBehaviorNormal) the content is played in normal direction. If you set the direction behavior property of the timeline to Timeline::DirectionBehaviorReverse, each iteration plays its portion of timeline content in reverse manner, that is, from the end to the beginning of the content portion. If you set direction behavior to Timeline::DirectionBehaviorPingPong, then each odd iteration plays its content normally and each even iteration plays its content in reverse manner.
To set the direction behavior of Timeline to one of the values from Timeline::DirectionBehavior call Timeline's setDirectionBehavior() function:
To retrieve the direction behavior of Timeline call its getDirectionBehavior() function.
The number of iterations in a timeline is affected by several properties of the timeline. In general, to define how many iterations should be played in a timeline set its repeat count property. But if the direction behavior of the timeline is set to Timeline::DirectionBehaviorPingPong, then each iteration has two sub-iterations (the first sub-iteration plays its portion of the timeline content in normal direction and the second one plays it in reverse direction), so the number of iterations defined by repeat count is doubled. For example, if you set repeat count to 10 and direction behavior to Timeline::DirectionBehaviorPingPong, the number of iterations in the timeline becomes 20. If you set repeat count to 0, the number of iterations in timeline becomes infinite.
To set the repeat count of Timeline call its setRepeatCount() function:
To retrieve the repeat count of Timeline call its getRepeatCount() function.
To perform playback of Timeline, create a TimelinePlayback object by calling the 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 the TimelinePlayback object which in turn will advance Timeline.
To start the playback of Timeline:
Do not change the properties of a timeline after you have added its playback to a clock. Changing any timeline property after its playback is added to a clock will result in undefined behavior.
Specifies the direction behavior for a timeline.
|
explicitprotected |
Constructor.
| domain | Domain. |
| chrono::milliseconds kanzi::Timeline::getStartTime | ( | ) | const |
Gets the start time of the timeline (in milliseconds).
| void kanzi::Timeline::setStartTime | ( | chrono::milliseconds | startTime | ) |
Gets the start time of the timeline (in milliseconds).
| startTime | Start time of timeline. |
| chrono::milliseconds kanzi::Timeline::getClipStartTime | ( | ) | const |
Gets the clip start time of the timeline (in milliseconds).
| void kanzi::Timeline::setClipStartTime | ( | chrono::milliseconds | clipStartTime | ) |
Sets the clip start time of the timeline (in milliseconds).
| clipStartTime | Clip start time of timeline. |
| optional<chrono::milliseconds> kanzi::Timeline::getClipDuration | ( | ) | const |
Gets the clip duration of the timeline (in milliseconds).
| void kanzi::Timeline::setClipDuration | ( | optional< chrono::milliseconds > | duration | ) |
Sets the clip duration of the timeline (in milliseconds).
| duration | Clip duration of timeline. |
| unsigned int kanzi::Timeline::getRepeatCount | ( | ) | const |
Gets the repeat count of the timeline (zero indicates infinite repeats).
| void kanzi::Timeline::setRepeatCount | ( | unsigned int | repeatCount | ) |
Sets the repeat count of the timeline (zero indicates infinite repeats).
| repeatCount | Repeat count of timeline. |
| DirectionBehavior kanzi::Timeline::getDirectionBehavior | ( | ) | const |
Gets the direction behavior of a timeline.
| void kanzi::Timeline::setDirectionBehavior | ( | DirectionBehavior | directionBehavior | ) |
Sets the direction behavior of a timeline.
| directionBehavior | Direction behavior of timeline. |
| float kanzi::Timeline::getDurationScale | ( | ) | const |
Gets the duration scale of timeline.
| void kanzi::Timeline::setDurationScale | ( | float | scale | ) |
Sets the duration scale of timeline.
If specified scale is smaller than minimum scale, the scale is clamped to minimum scale value.
| scale | Duration scale of timeline. |
| float kanzi::Timeline::getMinimumDurationScale | ( | ) | const |
Gets minimum duration scale.
| TimeInterval kanzi::Timeline::calculateClipInterval | ( | ) |
Calculates clip interval of timeline.
This content interval will be played by each iteration of timeline during its playback. Clip interval is calculated by applying clip start time and clip duration to content duration of timeline.
| unsigned int kanzi::Timeline::calculateIterationCount | ( | ) |
Calculates number of iterations in timeline.
Number of iteration is calculated from repeat count of timeline and its direction behavior.
| optional<chrono::milliseconds> kanzi::Timeline::calculateIterationDuration | ( | ) |
Calculates iteration duration.
Iteration duration is calculated by applying duration scale to duration of clipped content interval.
| optional<chrono::milliseconds> kanzi::Timeline::calculateDuration | ( | ) |
Calculates the duration of the timeline.
Timeline duration calculated as a iteration duration multiplied by iteration count. Timeline start time does not affect timeline duration. Returns nullopt if the duration of timeline is infinite.
| TimelinePlaybackSharedPtr kanzi::Timeline::createPlayback | ( | TimelinePlaybackContext & | context | ) |
|
protectedpure virtual |
Creates playback of the timeline.
| context | Context for playback. |
Implemented in kanzi::PropertyTargetInterpolationTimeline, kanzi::PropertyFieldAnimationTimeline, kanzi::ParallelTimeline, kanzi::PropertyTargetEasingTimeline, kanzi::ValueAccumulatorTimeline< TAccumulatedValue >, kanzi::PropertyAnimationTimeline, kanzi::MorphWeightTimeline, and kanzi::PreviewTimeline.
|
protectedvirtual |
Calculates the duration of the content of the timeline.
No timeline playback properties (e.g. start time, clip start time and duration, repeat count, etc) should be used when calculating content duration. By default content duration of timeline is zero milliseconds (empty timeline).
Reimplemented in kanzi::PropertyTargetInterpolationTimeline, kanzi::ParallelTimeline, kanzi::PropertyTargetEasingTimeline, kanzi::ValueAccumulatorTimeline< TAccumulatedValue >, kanzi::PropertyFieldAnimationTimeline, kanzi::MorphWeightTimeline, kanzi::PropertyAnimationTimeline, and kanzi::PreviewTimeline.
|
protectedvirtual |
Loads timeline data from KZB.
Subclasses of Timeline class can override this function to load type-specific timeline data. In this case override function should call loadOverride() of Timeline class before loading type-specific data.
| domain | Domain. |
| name | Timeline name. |
| kzbFile | KZB file to load timeline data from. |
| parser | Parser to parse timeline data. |
Reimplemented in kanzi::PropertyFieldAnimationTimeline, kanzi::ParallelTimeline, kanzi::PropertyAnimationTimeline, and kanzi::MorphWeightTimeline.
|
friend |
