Kanzi animation system consists of animations and timelines: More...

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

Inheritance diagram for kanzi::ParallelTimeline:

Public Types
typedef ChildContainer::const_iterator	ChildConstIterator

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

Public Member Functions
void	addChild (TimelineSharedPtr childTimeline)
	Adds a child timeline to the parallel timeline.

ChildConstIterator	beginChildren () const
	Returns an iterator pointing to the beginning of the child timelines container.

ChildConstIterator	endChildren () const
	Returns an iterator to the end of the child timelines container.

size_t	getChildCount () const
	Gets the number of child timelines.

string_view	getObjectPath () const
	Gets the animated target object path.

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

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

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

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

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

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

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

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

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

float	getMinimumDurationScale () const
	Gets minimum duration scale.

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

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

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

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

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

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

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

void	setStartTime (chrono::milliseconds startTime)
	Gets the start time of the timeline (in milliseconds).

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

Static Public Member Functions
static ParallelTimelineSharedPtr	create (Domain *domain)
	Creates a parallel timeline.

static TimelineSharedPtr	create (Domain *domain, string_view)
	Creates a parallel timeline.

static ObjectSharedPtr	load (Domain *domain, string_view name, KzbFile &kzbFile, KzbMemoryParser &parser)
	Loads timeline from KZB file.

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 Member Functions
optional< chrono::milliseconds >	calculateContentDuration () override
	Timeline::calculateContentDuration() implementation.

TimelinePlaybackSharedPtr	createPlaybackOverride (TimelinePlaybackContext &context) override
	Timeline::createPlaybackOverride() implementation.

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

	ParallelTimeline (Domain *domain)
	Constructor.

Protected Member Functions inherited from kanzi::Timeline
	Timeline (Domain *domain)
	Constructor.

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.

Friends
class	ParallelTimelinePlayback

Additional Inherited Members
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

Kanzi animation system consists of animations and timelines:

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

Parallel timeline allows you to group timelines which Kanzi plays at the same time. Use this timeline to organize collections of timelines and create a composition of timelines.

You can add child timelines to your parallel timeline by calling its addChild() function. You can also adjust the position of a child timeline, inside your parallel timeline, by setting the start time of the child timeline. A child timeline's start and global time are defined in the content time space of a parallel timeline. You can clip a child timeline by giving it a negative start time and the portion before the zero time will be clipped.

You can not add a child timeline once a parellel timeline has started animating, that is, after the playback of the parallel timeline has been added to a timeline clock. Doing so will result in an undefined behavior.

Since a parallel timeline is a group of its child timelines, the content duration of parallel timeline is defined as the union of its child timeline's durations, and is affected by their respective start times. For example, if you add a single timeline with a duration of 10 milliseconds and a start time of 5 milliseconds as a child to a parallel timeline, then the content duration of your parallel timeline would become 15 milliseconds.

Do note that a parallel timeline without any children has a 0 millisecond content duration.

Timeline properties affecting the playback, such as start time, repeat count, duration scale factor, direction behavior, clip start and clip duration, which are specified in parallel timeline, also affect its child timelines. For example, if direction behavior of parallel timeline is set to reverse, then all its child timelines are played in reverse manner, from the end to beginning. In this case, the time for child timelines will appear as going backwards.

Examples

To create a parallel timeline:

            // Create a parallel timeline.
            ParallelTimelineSharedPtr parallelTimeline = ParallelTimeline::create(domain);
            // Add propertyTimeline and propertyFieldTimeline timelines to the parallel timeline. Parallel timeline plays
            // both timelines at the same time.
            parallelTimeline->addChild(propertyTimeline);
            parallelTimeline->addChild(propertyFieldTimeline);

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

Member Typedef Documentation

◆ ChildConstIterator

typedef ChildContainer::const_iterator kanzi::ParallelTimeline::ChildConstIterator

Constructor & Destructor Documentation

◆ ParallelTimeline()

kanzi::ParallelTimeline::ParallelTimeline ( Domain * domain )

explicitprotected

Constructor.

Parameters

domain Domain.

Member Function Documentation

◆ create() [1/2]

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

inlinestatic

Creates a parallel timeline.

Parameters

domain Domain.

Returns: The created parallel timeline.

◆ addChild()

void kanzi::ParallelTimeline::addChild ( TimelineSharedPtr childTimeline )

Adds a child timeline to the parallel timeline.

Do not call this function after the playback of the parallel timeline has been added to a timeline clock.

Parameters

childTimeline Timeline to add to the parallel timeline.

◆ create() [2/2]

static ParallelTimelineSharedPtr kanzi::ParallelTimeline::create ( Domain * domain )

static

Creates a parallel timeline.

Parameters

domain Domain.

Returns: Parallel timeline.

◆ getChildCount()

size_t kanzi::ParallelTimeline::getChildCount ( ) const

inline

Gets the number of child timelines.

Returns: Number of child timelines.

◆ beginChildren()

ChildConstIterator kanzi::ParallelTimeline::beginChildren ( ) const

inline

Returns an iterator pointing to the beginning of the child timelines container.

Returns: Iterator to the beginning of the container.

◆ endChildren()

ChildConstIterator kanzi::ParallelTimeline::endChildren ( ) const

inline

Returns an iterator to the end of the child timelines container.

Returns: Iterator to the end of the container.

◆ getObjectPath()

string_view kanzi::ParallelTimeline::getObjectPath ( ) const

inline

Gets the animated target object path.

Returns: Relative path to the target object.

◆ load()

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

static

Loads timeline from KZB file.

Parameters

domain	Domain.
name	Timeline name.
kzbFile	KZB file to load timeline data from.
parser	Parser to parse timeline data.

Returns: Loaded timeline.

◆ createPlaybackOverride()

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

overrideprotectedvirtual

Timeline::createPlaybackOverride() implementation.

Implements kanzi::Timeline.

◆ calculateContentDuration()

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

overrideprotectedvirtual

Timeline::calculateContentDuration() implementation.

Reimplemented from kanzi::Timeline.

◆ loadOverride()

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

overrideprotectedvirtual

Timeline::loadOverride() implementation.

Reimplemented from kanzi::Timeline.

Friends And Related Symbol Documentation

◆ ParallelTimelinePlayback

friend class ParallelTimelinePlayback

friend

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

kanzi/core.ui/animation/parallel_timeline.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Examples

Member Typedef Documentation

◆ ChildConstIterator

Constructor & Destructor Documentation

◆ ParallelTimeline()

Member Function Documentation

◆ create() [1/2]

◆ addChild()

◆ create() [2/2]

◆ getChildCount()

◆ beginChildren()

◆ endChildren()

◆ getObjectPath()

◆ load()

◆ createPlaybackOverride()

◆ calculateContentDuration()

◆ loadOverride()

Friends And Related Symbol Documentation

◆ ParallelTimelinePlayback