kanzi::TimelinePlayback Class Reference

Playback object for timelines. Created for every timeline that is played. More...

#include <kanzi/animation/timeline_playback.hpp>

Inheritance diagram for kanzi::TimelinePlayback:

Public Types
typedef function< void(TimelinePlayback &)>	CompleteCallback

Public Member Functions
	TimelinePlayback (Domain *domain, TimelineSharedPtr timeline)
void	setCompleteCallback (CompleteCallback callback)
void	tick (chrono::milliseconds delta)
bool	isComplete ()
chrono::milliseconds	getTotalTime () const
chrono::milliseconds	getProgressTime () const
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...

Protected Member Functions
void	setComplete (bool complete)
virtual void	tickOverride (chrono::milliseconds delta)=0
Protected Member Functions inherited from kanzi::Object
void	initialize ()
void	onCopy (const Object &other)

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...
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. Created for every timeline that is played.

Member Typedef Documentation

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

Constructor & Destructor Documentation

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

inlineexplicit

Member Function Documentation

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

inline

void kanzi::TimelinePlayback::tick

(

chrono::milliseconds

delta

)

bool kanzi::TimelinePlayback::isComplete ( )

inline

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

inline

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

inline

void kanzi::TimelinePlayback::setComplete ( bool  complete )

inlineprotected

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

protectedpure virtual

Implemented in kanzi::PropertyAnimationTimelinePlayback, kanzi::PropertyFieldAnimationTimelinePlayback, and kanzi::ParallelTimelinePlayback.

---

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

• kanzi/animation/timeline_playback.hpp