The Kanzi animation system consists animations and timelines: animations define how to animate a property, and timelines map the animations to time and to objects you want to animate. More...

#include <kanzi/animation/property_animation_timeline.hpp>

Inheritance diagram for kanzi::PropertyAnimationTimeline:

Public Member Functions
	~PropertyAnimationTimeline ()

Public Member Functions inherited from kanzi::Timeline
TimelinePlaybackSharedPtr	createPlayback (TimelinePlaybackContext &context)

chrono::milliseconds	getStartTime () const

void	setStartTime (chrono::milliseconds startTime)

Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)

virtual	~Object ()

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

KzuPropertyManager *	getPropertyManager () const
	Returns the property manager of the object. More...

KzuTaskScheduler *	getTaskScheduler () const
	Returns the task scheduler of the object. More...

KzuMessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object. More...

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

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

bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it. More...

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value)
	Sets the local value of a property. More...

void	setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value)
	Sets the local value of a resource id property with a resource pointer. More...

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

template<typename DataType >
bool	getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) 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 >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value)

void	setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value)

template<typename DataType >
DataType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
bool	getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const

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

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

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property. More...

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

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

AppliedStyleEntry *	applyObjectStyle (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...

Static Public Member Functions
template<typename TValueType >
static PropertyAnimationTimelineSharedPtr	create (Domain *domain, string_view objectPath, const PropertyType< TValueType > &propertyType, shared_ptr< ValueAnimation< typename PropertyType< TValueType >::DataType > > animation)

static PropertyAnimationTimelineSharedPtr	create (Domain *domain, string_view objectPath, const PropertyType< Matrix4x4 > &propertyType, shared_ptr< SRTValue3DAnimation > animation)

static PropertyAnimationTimelineSharedPtr	create (Domain *domain, string_view objectPath, const PropertyType< Matrix3x3 > &propertyType, shared_ptr< SRTValue2DAnimation > animation)

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

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

Protected Member Functions
	PropertyAnimationTimeline (Domain *domain, string_view objectPath, AbstractPropertyType propertyType, AbstractAnimationSharedPtr animation)

virtual TimelinePlaybackSharedPtr	createPlaybackOverride (TimelinePlaybackContext &context) KZ_OVERRIDE

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

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Friends
class	PropertyAnimationTimelinePlayback

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

The Kanzi animation system consists animations and timelines: animations define how to animate a property, and timelines map the animations to time and to objects you want to animate.

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

Examples

To create a property timeline:

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

To play an animation regardless of the timeline type:

        // Create the playback context and the timeline playback for the node defined in the item2d.
        ScenegraphTimelinePlaybackContext context(*item2d);
        // Create the playback for the timeline defined in the propertyFieldTimeline.
        TimelinePlaybackSharedPtr playback = propertyFieldTimeline->createPlayback(context);
        // Start the animation.
        domain->getRootTimelineClock()->addTimelinePlayback(playback);

Constructor & Destructor Documentation

kanzi::PropertyAnimationTimeline::~PropertyAnimationTimeline ( )

inline

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

inlineexplicitprotected

Member Function Documentation

template<typename TValueType >

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

inlinestatic

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

inlinestatic

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

inlinestatic

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

inlinestatic

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

protectedvirtual

Implements kanzi::Timeline.

Friends And Related Function Documentation

friend class PropertyAnimationTimelinePlayback

friend

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

kanzi/animation/property_animation_timeline.hpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Examples

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation