kanzi::PlayAnimationAction Class Reference

Play animation action is the action which starts playback of specified timeline when it is invoked. More...

#include <kanzi/core.ui/action/play_animation_action.hpp>

Inheritance diagram for kanzi::PlayAnimationAction:

Public Member Functions
void	play ()
	Starts playback of timeline specified in the Animation property. More...
void	stop ()
	Stops currently ongoing playback. More...
Public Member Functions inherited from kanzi::Action
string	getName () const
void	attach (Trigger *trigger)
	Attaches the action to a trigger. More...
void	detach ()
	Detaches the action. More...
void	invoke ()
	Invokes the action. More...
ActionSharedPtr	copy () const
	Create a copy of the action. More...
Trigger *	getTrigger () const
	Returns the trigger the action is attached to. More...
chrono::milliseconds	getDelay () const
void	setDelay (chrono::milliseconds delay)
virtual void	load (KzcInputStream *inputStream, const KzuBinaryFileInfo *file)
virtual void	load (KzbFile &kzbFile, KzbMemoryParser &parser)
Public Member Functions inherited from kanzi::Object
	Object (Domain *domain)
virtual	~Object ()
Domain *	getDomain () const
	Returns the domain the object belongs to. 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 KZ_OVERRIDE
	Returns the metaclass of the dynamic type of the object. More...
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object. More...
void	unapplyObjectStyle (AppliedStyleEntrySharedPtr 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...

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
static PlayAnimationActionSharedPtr	create (Domain *domain, string_view name)
Static Public Member Functions inherited from kanzi::Action
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
static ActionSharedPtr	loadAction (KzcInputStream *inputStream, Domain *domain, const KzuBinaryFileInfo *file)
static ActionSharedPtr	loadAction (Domain *domain, KzbFile &kzbFile, KzbMemoryParser &parser)
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 Member Functions
	PlayAnimationAction (Domain *domain, string_view name)
	Create a play animation action. More...
virtual void	onAttach () KZ_OVERRIDE
	Attach play animation action. More...
virtual void	onDetach () KZ_OVERRIDE
	Detach play animation action. More...
virtual void	onInvoke () KZ_OVERRIDE
	Invoke play animation action. More...
virtual void	onDelayedInvoke () KZ_OVERRIDE
	Implementation of delayed invoke of play animation action. More...
virtual ActionSharedPtr	clone () const KZ_OVERRIDE
Protected Member Functions inherited from kanzi::Action
	Action (Domain *domain, string_view name)
virtual void	onPrepareDelayedInvoke ()
	Callback called before delayed invoke. More...
virtual void	onUnprepareDelayedInvoke ()
	Callback called after delayed invoke. More...
void	onCopy (const Action &other)
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::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) const
AbstractPropertyTypeDescriptor::ValueSourceEntry *	getTopValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const
AbstractPropertyTypeDescriptor::ValueSourceEntry *	findLocalValueSourceEntry (AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (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::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)
AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (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)

Properties
static PropertyType< string >	AnimatedObjectPathProperty
	AnimatedObjectPath property. More...
static PropertyType< ResourceSharedPtr >	AnimationProperty
	Animation property. More...
static PropertyType< KzuTimeLineEntryPlaybackMode >	PlaybackModeProperty
	PlaybackMode property. More...
static PropertyType< float >	DurationScaleProperty
	DurationScale property. More...
static PropertyType< int >	RepeatCountProperty
	RepeatCount property. More...
static PropertyType< bool >	RestoreOriginalValuesAfterPlaybackProperty
	RestoreOriginalValuesAfterPlayback property. More...
static PropertyType< bool >	RelativePlaybackProperty
	RelativePlayback property. More...
string	getAnimatedObjectPath () const
	Gets the value of AnimatedObjectPathProperty. More...
void	setAnimatedObjectPath (string value)
	Sets the value of AnimatedObjectPathProperty. More...
ResourceSharedPtr	getAnimation () const
	Gets the value of AnimationProperty. More...
void	setAnimation (ResourceSharedPtr value)
	Sets the value of AnimationProperty. More...
KzuTimeLineEntryPlaybackMode	getPlaybackMode () const
	Gets the value of PlaybackModeProperty. More...
void	setPlaybackMode (KzuTimeLineEntryPlaybackMode value)
	Sets the value of PlaybackModeProperty. More...
float	getDurationScale () const
	Gets the value of DurationScaleProperty. More...
void	setDurationScale (float value)
	Sets the value of DurationScaleProperty. More...
int	getRepeatCount () const
	Gets the value of RepeatCountProperty. More...
void	setRepeatCount (int value)
	Sets the value of RepeatCountProperty. More...
bool	isRestoreOriginalValuesAfterPlayback () const
	Gets the value of RestoreOriginalValuesAfterPlaybackProperty. More...
void	setRestoreOriginalValuesAfterPlayback (bool value)
	Sets the value of RestoreOriginalValuesAfterPlaybackProperty. More...
bool	isRelativePlayback () const
	Gets the value of RelativePlaybackProperty. More...
void	setRelativePlayback (bool value)
	Sets the value of RelativePlaybackProperty. More...

Additional Inherited Members
Public Types inherited from kanzi::PropertyObject
typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr
typedef vector< PropertyStoragePtr >	PropertyStorageContainer
typedef PropertyStorageContainer::iterator	PropertyStorageIterator
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator
typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator
Static Public Attributes inherited from kanzi::Action
static PropertyType< int >	DelayProperty
	Delay property. 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...

Detailed Description

Play animation action is the action which starts playback of specified timeline when it is invoked.

Play animation action performs playback of timeline specified in the Animation property. All animations in applied timeline are relative: values calculated in animations are added to property values instead of replacing it. Paths to animated objects are resolved relative to the path specified in the AnimatedObjectPathProperty. The path in AnimatedObjectPathProperty is resolved relative to the node where play animation action is attached. If the path could not be resolved, play animation action will not start playback.

If play animation action is invoked before its ongoing playback is finished, the action will stop ongoing playback and start new one. If play animation action is detached from the node while its playback is ongoing, the action will stop the playback.

Constructor & Destructor Documentation

kanzi::PlayAnimationAction::PlayAnimationAction ( Domain *  domain, string_view  name  )

explicitprotected

Create a play animation action.

Member Function Documentation

string kanzi::PlayAnimationAction::getAnimatedObjectPath ( ) const

inline

Gets the value of AnimatedObjectPathProperty.

See also

setAnimatedObjectPath()

void kanzi::PlayAnimationAction::setAnimatedObjectPath ( string  value )

inline

Sets the value of AnimatedObjectPathProperty.

See also

getAnimatedObjectPath()

ResourceSharedPtr kanzi::PlayAnimationAction::getAnimation ( ) const

inline

Gets the value of AnimationProperty.

See also

setAnimation()

void kanzi::PlayAnimationAction::setAnimation ( ResourceSharedPtr  value )

inline

Sets the value of AnimationProperty.

See also

getAnimation()

KzuTimeLineEntryPlaybackMode kanzi::PlayAnimationAction::getPlaybackMode ( ) const

inline

Gets the value of PlaybackModeProperty.

See also

setPlaybackMode()

void kanzi::PlayAnimationAction::setPlaybackMode ( KzuTimeLineEntryPlaybackMode  value )

inline

Sets the value of PlaybackModeProperty.

See also

getPlaybackMode()

float kanzi::PlayAnimationAction::getDurationScale ( ) const

inline

Gets the value of DurationScaleProperty.

See also

setDurationScale()

void kanzi::PlayAnimationAction::setDurationScale ( float  value )

inline

Sets the value of DurationScaleProperty.

See also

getDurationScale()

int kanzi::PlayAnimationAction::getRepeatCount ( ) const

inline

Gets the value of RepeatCountProperty.

See also

setRepeatCount()

void kanzi::PlayAnimationAction::setRepeatCount ( int  value )

inline

Sets the value of RepeatCountProperty.

See also

getRepeatCount()

bool kanzi::PlayAnimationAction::isRestoreOriginalValuesAfterPlayback ( ) const

inline

Gets the value of RestoreOriginalValuesAfterPlaybackProperty.

See also

setRestoreOriginalValuesAfterPlayback()

void kanzi::PlayAnimationAction::setRestoreOriginalValuesAfterPlayback ( bool  value )

inline

Sets the value of RestoreOriginalValuesAfterPlaybackProperty.

See also

isRestoreOriginalValuesAfterPlayback()

bool kanzi::PlayAnimationAction::isRelativePlayback ( ) const

inline

Gets the value of RelativePlaybackProperty.

See also

setRelativePlayback()

void kanzi::PlayAnimationAction::setRelativePlayback ( bool  value )

inline

Sets the value of RelativePlaybackProperty.

See also

isRelativePlayback()

static PropertyTypeEditorInfoSharedPtr kanzi::PlayAnimationAction::makeEditorInfo ( )

static

static PlayAnimationActionSharedPtr kanzi::PlayAnimationAction::create ( Domain *  domain, string_view  name  )

static

void kanzi::PlayAnimationAction::play

(

)

Starts playback of timeline specified in the Animation property.

If play animation action has currently ongoing playback, the playback will be stopped before starting new one.

void kanzi::PlayAnimationAction::stop

(

)

Stops currently ongoing playback.

Next invocation of play animation action or next call to its play() function will start new playback. If there is no currently ongoing playback, this function will do nothing.

virtual void kanzi::PlayAnimationAction::onAttach ( )

protectedvirtual

Attach play animation action.

Reimplemented from kanzi::Action.

virtual void kanzi::PlayAnimationAction::onDetach ( )

protectedvirtual

Detach play animation action.

Reimplemented from kanzi::Action.

virtual void kanzi::PlayAnimationAction::onInvoke ( )

protectedvirtual

Invoke play animation action.

Reimplemented from kanzi::Action.

virtual void kanzi::PlayAnimationAction::onDelayedInvoke ( )

protectedvirtual

Implementation of delayed invoke of play animation action.

Reimplemented from kanzi::Action.

virtual ActionSharedPtr kanzi::PlayAnimationAction::clone ( ) const

protectedvirtual

Implements kanzi::Action.

Member Data Documentation

PropertyType<string> kanzi::PlayAnimationAction::AnimatedObjectPathProperty

static

AnimatedObjectPath property.

The default value is ".".

See also

setAnimatedObjectPath(), getAnimatedObjectPath()

PropertyType<ResourceSharedPtr> kanzi::PlayAnimationAction::AnimationProperty

static

Animation property.

The default value is ResourceSharedPtr().

See also

setAnimation(), getAnimation()

PropertyType<KzuTimeLineEntryPlaybackMode> kanzi::PlayAnimationAction::PlaybackModeProperty

static

PlaybackMode property.

The default value is KZU_TIME_LINE_ENTRY_PLAYBACK_MODE_NORMAL.

See also

setPlaybackMode(), getPlaybackMode()

PropertyType<float> kanzi::PlayAnimationAction::DurationScaleProperty

static

DurationScale property.

The default value is 1.0f.

See also

setDurationScale(), getDurationScale()

PropertyType<int> kanzi::PlayAnimationAction::RepeatCountProperty

static

RepeatCount property.

The default value is 1.

See also

setRepeatCount(), getRepeatCount()

PropertyType<bool> kanzi::PlayAnimationAction::RestoreOriginalValuesAfterPlaybackProperty

static

RestoreOriginalValuesAfterPlayback property.

The default value is false.

See also

setRestoreOriginalValuesAfterPlayback(), isRestoreOriginalValuesAfterPlayback()

PropertyType<bool> kanzi::PlayAnimationAction::RelativePlaybackProperty

static

RelativePlayback property.

The default value is false.

See also

setRelativePlayback(), isRelativePlayback()

---

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

• kanzi/core.ui/action/play_animation_action.hpp